Synupv1
Criar chave
v1Recursos/Posts/postCriar uma publicação

Criar uma publicação

Cria uma publicação para um local ou cliente e a envia para as plataformas selecionadas. Isto publica conteúdo real: a menos que scheduledFor esteja definido ou draft seja true, a publicação vai ao ar imediatamente em suas plataformas de destino. Uma plataforma solicitada sem conexão ativa, ou uma publicação sem um campo obrigatório para ir ao ar, nunca faz a chamada falhar — o conteúdo é salvo como rascunho; veja o esquema de resposta para saber como isso é reportado.

post/api/v1/posts
posts:write
Corpo da solicitação
locationIdstringopcional
O local para o qual publicar. Forneça este ou clientId.
clientIdstringopcional
O cliente para o qual publicar em nível de marca. Forneça este ou locationId.
namestringobrigatório
Nome/rótulo interno da publicação. Obrigatório, não pode ser vazio.
postTypestring (announcement | event | offer)obrigatório
Tipo de publicação. event e offer são exclusivos do Google.
platformsarray of string (google | facebook | instagram | x | linkedin | pinterest | mastodon | bluesky | threads | tiktok)obrigatório
Plataformas de destino. É necessário pelo menos uma.
connectionIdsarray of stringopcional
IDs de conexão explícitos pelos quais publicar, em vez de resolver plataformas para conexões.
messageGooglestringopcional
Legenda para o Google. Obrigatória quando google é selecionado, a menos que seja draft.
messageFacebookstringopcional
Legenda social compartilhada para toda plataforma selecionada que não seja Google. Obrigatória, a menos que seja draft.
ctaTypestring (learn_more | sign_up | order_online | book | buy | call_now)opcional
Tipo de chamada para ação.
ctaUrlstringopcional
URL de destino da chamada para ação.
mediaUrlsarray of objectopcional
Mídia a ser anexada, uma entrada por anexo de plataforma.
urlstringopcional
platformstringopcional
typestring (image | video)opcional
eventTitlestringopcional
Título do evento ou oferta. Obrigatório para um event/offer do Google, a menos que seja draft.
eventStartAtstringopcional
Horário de início do evento ou oferta, como timestamp ISO 8601. Obrigatório para um event/offer do Google, a menos que seja draft.
eventEndAtstringopcional
Horário de término do evento ou oferta, como timestamp ISO 8601. Deve ser posterior ao início.
offerTermsstringopcional
Termos da oferta.
offerCouponCodestringopcional
Código do cupom da oferta.
offerRedeemUrlstringopcional
URL de resgate da oferta.
scheduledForstringopcional
Publica neste timestamp ISO 8601 futuro em vez de imediatamente.
draftbooleanopcional
Salva sem publicar. Ignora verificações de campos obrigatórios; verificações estruturais (limites, regras de mídia) ainda se aplicam.
Resposta
dataobjectopcional
Uma plataforma solicitada sem conexão ativa, ou um campo obrigatório que a publicação precisa antes de poder ir ao ar, nunca faz esta chamada falhar — a publicação ainda é salva. Quando existe uma dessas lacunas, status é "no_connection" ou "incomplete" e a publicação fica embutida em post.{id,status}; em uma publicação bem-sucedida, o id/status de nível superior descrevem a publicação diretamente.
idstringopcional
Identificador único da publicação.
statusstringopcional
Status do ciclo de vida da publicação: draft, scheduled, active ou error.
missingFieldsarray of stringopcional
Campos ainda necessários antes que esta publicação possa ir ao ar, se houver.
missingPlatformsarray of stringopcional
Plataformas solicitadas sem conexão ativa, se houver.
scopestring (location | client)opcional
Se a lacuna de conexão/campo se aplica no nível do local ou do cliente.
postobjectopcional
A publicação que foi criada ou atualizada.
idstringopcional
Identificador único da publicação.
statusstringopcional
Status do ciclo de vida da publicação: draft, scheduled, active ou error.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
422Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/posts
Sua chave de API
Corpo da solicitação*
{
  "data": {
    "id": "cm_post_abc123",
    "status": "scheduled"
  }
}