Social media

create_social_post

Write

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.

Permission

social:write

Operation

social.posts.create

Parameters

titlestringoptional

Nome interno no calendário.

captionstringoptional

Legenda do post.

hashtagsstring[]optional

hashtagsInFirstCommentbooleanoptional

linkUrlstring (uri)optional

mediaobject[]optional

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

media[].artIdstringoptional

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

media[].videoProjectIdstringoptional

Vídeo pronto do Izy Studio (list_studio_videos).

media[].videoVersionstringoptional

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

media[].urlstring (uri)optional

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[].altTextstringoptional

Texto alternativo da imagem.

targetsobject[]optional

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

targets[].socialAccountIdstringoptional

targets[].platformstringoptional

INSTAGRAMFACEBOOKLINKEDINTIKTOKYOUTUBE

targets[].formatstringrequired

FEEDCAROUSELREELSTORYVIDEOSHORTTIKTOK_VIDEOLINKEDIN_POSTLINKEDIN_CAROUSELLINKEDIN_ARTICLE

targets[].captionOverridestringoptional

targets[].titlestringoptional

targets[].platformDataobjectoptional

needsRecordingbooleanoptional

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)optional

Data e hora com fuso (ISO 8601).

sendstringoptional

draftapprovalschedulenow

notestringoptional

Recado para quem aprova.

delete_social_post

Write

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

Permission

social:write

Operation

social.posts.delete

Parameters

idstringrequired

get_social_media_upload_url

Write

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).

Permission

social:write

Operation

social.media.upload_url

Parameters

fileNamestringrequired

mimeTypestringrequired

image/jpegimage/pngvideo/mp4video/quicktimevideo/webm

sizeintegerrequired

Tamanho em bytes.

get_social_post

Read

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

Permission

social:read

Operation

social.posts.get

Parameters

idstringrequired

list_social_accounts

Read

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.

Permission

social:read

Operation

social.accounts.list

Parameters

No parameters.

list_social_posts

Read

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.

Permission

social:read

Operation

social.posts.list

Parameters

fromstring (date-time)optional

tostring (date-time)optional

statusstringoptional

DRAFTSCHEDULEDPUBLISHINGPUBLISHEDPARTIALFAILED

platformstringoptional

INSTAGRAMFACEBOOKLINKEDINTIKTOKYOUTUBE

pageintegeroptional

list_studio_arts

Read

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

Permission

social:read

Operation

social.studio.arts

Parameters

statusstringoptional

DRAFTAPPROVED

limitintegeroptional

list_studio_videos

Read

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

Permission

social:read

Operation

social.studio.videos

Parameters

limitintegeroptional

schedule_social_post

Write

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.

Permission

social:publish

Operation

social.posts.schedule

Parameters

idstringrequired

scheduledAtstring (date-time)optional

nowbooleanoptional

set_social_post_date

Write

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.

Permission

social:write

Operation

social.posts.set_date

Parameters

idstringrequired

scheduledAtstring (date-time)required

submit_social_post_for_approval

Write

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.

Permission

social:write

Operation

social.posts.submit

Parameters

idstringrequired

scheduledAtstring (date-time)optional

notestringoptional

unschedule_social_post

Write

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

Permission

social:write

Operation

social.posts.unschedule

Parameters

idstringrequired

update_social_post

Write

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.

Permission

social:write

Operation

social.posts.update

Parameters

idstringrequired

titlestringoptional

Nome interno no calendário.

captionstringoptional

Legenda do post.

hashtagsstring[]optional

hashtagsInFirstCommentbooleanoptional

linkUrlstring (uri)optional

mediaobject[]optional

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

media[].artIdstringoptional

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

media[].videoProjectIdstringoptional

Vídeo pronto do Izy Studio (list_studio_videos).

media[].videoVersionstringoptional

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

media[].urlstring (uri)optional

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[].altTextstringoptional

Texto alternativo da imagem.

targetsobject[]optional

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

targets[].socialAccountIdstringoptional

targets[].platformstringoptional

INSTAGRAMFACEBOOKLINKEDINTIKTOKYOUTUBE

targets[].formatstringrequired

FEEDCAROUSELREELSTORYVIDEOSHORTTIKTOK_VIDEOLINKEDIN_POSTLINKEDIN_CAROUSELLINKEDIN_ARTICLE

targets[].captionOverridestringoptional

targets[].titlestringoptional

targets[].platformDataobjectoptional

needsRecordingbooleanoptional

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.