Redes sociais

create_social_post

Escrita

Cria um post no calendário com arte, vídeo ou arquivo próprio. send: "draft" guarda o rascunho (scheduledAt é a data planejada); "approval" manda para aprovação da equipe e, aprovado, entra sozinho na agenda em scheduledAt; "schedule" agenda direto em scheduledAt; "now" publica já. "schedule" e "now" exigem o escopo social:publish e respeitam a regra de aprovação da empresa.

Permissão

social:write

Operação

social.posts.create

Parâmetros

titlestringopcional

Nome interno no calendário.

captionstringopcional

Legenda do post.

hashtagsstring[]opcional

hashtagsInFirstCommentbooleanopcional

linkUrlstring (uri)opcional

mediaobject[]opcional

Mídias na ordem do post (até 10 no total, contando as páginas das artes).

media[].artIdstringopcional

Arte do Izy Studio (list_studio_arts). Cada página vira uma imagem do post.

media[].videoProjectIdstringopcional

Vídeo pronto do Izy Studio (list_studio_videos).

media[].videoVersionstringopcional

Versão do vídeo: REEL 9:16 (padrão), SQUARE 1:1, LANDSCAPE 16:9.REELSQUARELANDSCAPE

media[].urlstring (uri)opcional

Imagem (JPEG/PNG) ou vídeo (MP4/MOV/WEBM) por URL pública, até 200 MB: o Cognizy baixa e guarda. Também aceita a url devolvida por get_social_media_upload_url.

media[].altTextstringopcional

Texto alternativo da imagem.

targetsobject[]opcional

Onde publicar: socialAccountId (list_social_accounts) e format (FEED, CAROUSEL, STORY, REEL…). Sem conta, só a platform = post para publicar à mão.

targets[].socialAccountIdstringopcional

targets[].platformstringopcional

INSTAGRAMFACEBOOKLINKEDINTIKTOKYOUTUBE

targets[].formatstringobrigatório

FEEDCAROUSELREELSTORYVIDEOSHORTTIKTOK_VIDEOLINKEDIN_POSTLINKEDIN_CAROUSELLINKEDIN_ARTICLE

targets[].captionOverridestringopcional

targets[].titlestringopcional

targets[].platformDataobjectopcional

needsRecordingbooleanopcional

true = a própria pessoa precisa gravar o vídeo (falando para a câmera, bastidor): o calendário mostra "Gravar" até o post ter um vídeo.

scheduledAtstring (date-time)opcional

Data e hora com fuso (ISO 8601).

sendstringopcional

draftapprovalschedulenow

notestringopcional

Recado para quem aprova.

delete_social_post

Escrita

Apaga um post. O que nunca saiu é apagado; o que já saiu em alguma rede só some do Cognizy (na rede continua no ar).

Permissão

social:write

Operação

social.posts.delete

Parâmetros

idstringobrigatório

get_social_media_upload_url

Escrita

Para arquivo local ou acima de 200 MB (até 1 GB): devolve uploadUrl (envie o arquivo com PUT e o header Content-Type igual ao mimeType) e url (use em media[].url depois do envio).

Permissão

social:write

Operação

social.media.upload_url

Parâmetros

fileNamestringobrigatório

mimeTypestringobrigatório

image/jpegimage/pngvideo/mp4video/quicktimevideo/webm

sizeintegerobrigatório

Tamanho em bytes.

get_social_post

Leitura

Um post com legenda, mídias, destinos (status e link de cada rede), aprovação e dados pendentes.

Permissão

social:read

Operação

social.posts.get

Parâmetros

idstringobrigatório

list_social_accounts

Leitura

Contas de rede social conectadas (Instagram, Facebook, LinkedIn, TikTok, YouTube), com o id para usar em targets.socialAccountId. Conta com status diferente de ACTIVE precisa ser reconectada na tela.

Permissão

social:read

Operação

social.accounts.list

Parâmetros

Sem parâmetros.

list_social_posts

Leitura

Posts do calendário. Com from e to (até 45 dias): os posts do período (agendados, publicados e rascunhos com data) mais os rascunhos sem data. Sem período: lista paginada, filtrável por status.

Permissão

social:read

Operação

social.posts.list

Parâmetros

fromstring (date-time)opcional

tostring (date-time)opcional

statusstringopcional

DRAFTSCHEDULEDPUBLISHINGPUBLISHEDPARTIALFAILED

platformstringopcional

INSTAGRAMFACEBOOKLINKEDINTIKTOKYOUTUBE

pageintegeropcional

list_studio_arts

Leitura

Artes do Izy Studio prontas para usar em post (com imagem renderizada), das mais recentes. Use o id em media[].artId.

Permissão

social:read

Operação

social.studio.arts

Parâmetros

statusstringopcional

DRAFTAPPROVED

limitintegeropcional

list_studio_videos

Leitura

Vídeos prontos do Izy Studio, dos mais recentes, com as versões montadas (REEL, SQUARE, LANDSCAPE). Use o id em media[].videoProjectId.

Permissão

social:read

Operação

social.studio.videos

Parâmetros

limitintegeropcional

schedule_social_post

Escrita

Agenda direto um rascunho em scheduledAt (sem data: a data planejada) ou publica já com now: true. Se a empresa exige aprovação, o post precisa estar aprovado; senão use submit_social_post_for_approval.

Permissão

social:publish

Operação

social.posts.schedule

Parâmetros

idstringobrigatório

scheduledAtstring (date-time)opcional

nowbooleanopcional

set_social_post_date

Escrita

Muda a data de um post. Rascunho: a data planejada (null tira do calendário). Agendado: o novo horário da fila, que precisa ser futuro.

Permissão

social:write

Operação

social.posts.set_date

Parâmetros

idstringobrigatório

scheduledAtstring (date-time)obrigatório

submit_social_post_for_approval

Escrita

Manda um rascunho para aprovação da equipe (avisa quem aprova). Com scheduledAt (ou a data planejada do post), aprovado, ele entra sozinho na agenda nesse horário.

Permissão

social:write

Operação

social.posts.submit

Parâmetros

idstringobrigatório

scheduledAtstring (date-time)opcional

notestringopcional

unschedule_social_post

Escrita

Tira um post agendado da fila: volta a rascunho com a data planejada.

Permissão

social:write

Operação

social.posts.unschedule

Parâmetros

idstringobrigatório

update_social_post

Escrita

Edita um post que ainda não saiu: só os campos enviados mudam (media e targets, quando enviados, trocam a lista inteira). Mudar o conteúdo de um post aprovado tira a aprovação. Post agendado continua agendado, e editá-lo exige o escopo social:publish.

Permissão

social:write

Operação

social.posts.update

Parâmetros

idstringobrigatório

titlestringopcional

Nome interno no calendário.

captionstringopcional

Legenda do post.

hashtagsstring[]opcional

hashtagsInFirstCommentbooleanopcional

linkUrlstring (uri)opcional

mediaobject[]opcional

Mídias na ordem do post (até 10 no total, contando as páginas das artes).

media[].artIdstringopcional

Arte do Izy Studio (list_studio_arts). Cada página vira uma imagem do post.

media[].videoProjectIdstringopcional

Vídeo pronto do Izy Studio (list_studio_videos).

media[].videoVersionstringopcional

Versão do vídeo: REEL 9:16 (padrão), SQUARE 1:1, LANDSCAPE 16:9.REELSQUARELANDSCAPE

media[].urlstring (uri)opcional

Imagem (JPEG/PNG) ou vídeo (MP4/MOV/WEBM) por URL pública, até 200 MB: o Cognizy baixa e guarda. Também aceita a url devolvida por get_social_media_upload_url.

media[].altTextstringopcional

Texto alternativo da imagem.

targetsobject[]opcional

Onde publicar: socialAccountId (list_social_accounts) e format (FEED, CAROUSEL, STORY, REEL…). Sem conta, só a platform = post para publicar à mão.

targets[].socialAccountIdstringopcional

targets[].platformstringopcional

INSTAGRAMFACEBOOKLINKEDINTIKTOKYOUTUBE

targets[].formatstringobrigatório

FEEDCAROUSELREELSTORYVIDEOSHORTTIKTOK_VIDEOLINKEDIN_POSTLINKEDIN_CAROUSELLINKEDIN_ARTICLE

targets[].captionOverridestringopcional

targets[].titlestringopcional

targets[].platformDataobjectopcional

needsRecordingbooleanopcional

true = a própria pessoa precisa gravar o vídeo (falando para a câmera, bastidor): o calendário mostra "Gravar" até o post ter um vídeo.