Synup
Criar chave
v1Recursos/Distribuição/postImportar um pacote de conteúdo

Importar um pacote de conteúdo

Importa um pacote como rascunhos de publicação. Nada é agendado nem publicado: uma pessoa no Synup revisa, aprova e agenda cada publicação. Reenviar o mesmo externalId e a mesma versão da campanha, ou o mesmo Idempotency-Key, retorna o primeiro resultado. A mesma versão com conteúdo diferente retorna 409 version_conflict, então envie-a como version + 1.

post/api/v1/distribution/packages
distribution:write
Parâmetros de consulta
Idempotency-Keystringopcional
Qualquer string única por importação lógica. Uma nova tentativa com a mesma chave retorna o primeiro resultado.
clientIdstringopcional
O cliente, quando o corpo é um arquivo text/markdown bruto.
Corpo da solicitação
clientIdstringobrigatório
O cliente ao qual o pacote pertence.
manifestobjectopcional
Um manifesto synup.distribution/v1: a campanha, seus arquivos (assets) e uma variante por publicação de destino.
schemastring (synup.distribution/v1)obrigatório
campaignobjectobrigatório
externalIdstringobrigatório
versionintegerobrigatório
titlestringobrigatório
templatestringopcional
subjectstringopcional
canonicalUrlstringopcional
anchorVideoUrlstringopcional
customerReviewRequiredbooleanopcional
allowRawAssetsbooleanopcional
slackobjectopcional
teamIdstringopcional
channelIdstringopcional
threadTsstringopcional
assetsarray of objectobrigatório
idstringobrigatório
rolestring (video | image | cover | captions | document | raw)obrigatório
filenamestringobrigatório
mimestringobrigatório
bytesintegerobrigatório
sha256stringobrigatório
widthintegeropcional
heightintegeropcional
durationSecnumberopcional
languagestringopcional
sourceobjectopcional
urlstringopcional
provenanceobjectopcional
attributionRequiredbooleanopcional
customerReviewRequiredbooleanopcional
variantsarray of objectobrigatório
keystringobrigatório
platformstring (facebook | instagram | linkedin | x | pinterest | threads | bluesky | mastodon | reddit | medium | substack | vimeo | dailymotion | youtube | tiktok)obrigatório
connectionIdstringopcional
formatstring (feed | video | reel | short | image | carousel | article | link | text)opcional
textstringopcional
titlestringopcional
descriptionstringopcional
mediaarray of stringopcional
coverstringopcional
captionsstringopcional
firstCommentstringopcional
linkobjectopcional
urlstringopcional
utmobjectopcional
articleobjectopcional
titlestringopcional
subtitlestringopcional
htmlstringopcional
redditobjectopcional
subredditstringopcional
flairstringopcional
postTypestring (text | link | image | video)opcional
tagsarray of stringopcional
videoobjectopcional
privacystringopcional
categorystringopcional
isForKidsbooleanopcional
playlistIdstringopcional
tiktokobjectopcional
disableCommentbooleanopcional
disableDuetbooleanopcional
disableStitchbooleanopcional
brandContentbooleanopcional
suggestedAtstringopcional
timezonestringopcional
customerReviewRequiredbooleanopcional
markdownstringopcional
Um arquivo Series Markdown, enviado no lugar de manifest.
fileNamestringopcional
O nome do arquivo Markdown. Um nome .md marca a string como Markdown.
filesarray of objectopcional
Tamanho e sha256 de cada arquivo que o Markdown nomeia, associados pelo nome do arquivo. Obrigatório para importar uma série com arquivos; a pré-visualização aceita sem eles.
filenamestringobrigatório
bytesintegerobrigatório
sha256stringobrigatório
widthintegeropcional
heightintegeropcional
durationSecnumberopcional
urlstringopcional
Um link https do qual o Synup busca o arquivo, em vez de você fazer o upload.
intoSeriesIdstringopcional
Importa o arquivo como a próxima versão desta série existente.
Resposta
dataobjectopcional
campaignIdstringopcional
versionintegeropcional
statusstring (imported | unchanged)opcional
itemsarray of objectopcional
kindstring (asset | variant)opcional
refstringopcional
outcomestring (created | revised | unchanged | update_available | published_unchanged | skipped)opcional
postIdstringopcional
assetIdstringopcional
messagesarray of stringopcional
pendingUploadsarray of objectopcional
assetIdstringopcional
refstringopcional
filenamestringopcional
bytesintegeropcional
mimestringopcional
pendingFetchesarray of stringopcional
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.
404O recurso não foi encontrado, ou não pertence à sua agência.
409A solicitação entra em conflito com o estado atual do recurso — por exemplo, alterar o e-mail ou telefone de um destinatário que já recebeu uma mensagem, ou um convite de equipe que já foi aceito (ou que ainda não foi aceito).
422O arquivo Markdown tem erros, então nada foi importado. issues os lista por linha.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
post/api/v1/distribution/packages
Sua chave de API
Idempotency-Key
clientId
Corpo da solicitação*
{
  "data": {
    "campaignId": "dcm_123",
    "version": 1,
    "status": "imported",
    "items": [
      {
        "kind": "asset",
        "ref": "short-1",
        "outcome": "created",
        "assetId": "das_123",
        "messages": []
      },
      {
        "kind": "asset",
        "ref": "short-1-cover",
        "outcome": "created",
        "assetId": "das_124",
        "messages": []
      },
      {
        "kind": "variant",
        "ref": "short-1-linkedin",
        "outcome": "created",
        "postId": "post_123",
        "messages": []
      }
    ],
    "pendingUploads": [
      {
        "assetId": "das_124",
        "ref": "short-1-cover",
        "filename": "short-1.jpg",
        "bytes": 34683,
        "mime": "image/jpeg"
      }
    ],
    "pendingFetches": [
      "das_123"
    ]
  }
}

Novo na API da Synup?