Posts

Crie, liste e exclua posts de redes sociais via API.

Criar post

POST /public/v1/posts

Crie um novo post como rascunho, agende para depois ou publique imediatamente.

Requisição

curl -X POST \
  -H "Authorization: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "schedule",
    "date": "2026-05-01T14:00:00Z",
    "posts": [
      {
        "channel": { "id": "channel-uuid" },
        "value": [
          {
            "content": "Confira nosso novo lançamento!",
            "id": "unique-uuid",
            "image": []
          }
        ]
      }
    ]
  }' \
  https://api.postzee.app/public/v1/posts

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	`"now"` (publicar imediatamente), `"schedule"` ou `"draft"`
`date`	string	Apenas agendamento	Data e hora UTC no formato ISO 8601 (ex.: `"2026-05-01T14:00:00Z"`)
`posts`	array	Sim	Array de objetos de post (um por canal)
`posts[].channel.id`	string	Sim	ID do canal vindo do endpoint de Canais
`posts[].value[].content`	string	Sim	Conteúdo de texto do post
`posts[].value[].id`	string	Sim	Identificador único (UUID) para este bloco de conteúdo
`posts[].value[].image`	array	Não	Array de objetos de mídia para anexar
`posts[].settings`	object	Não	Configurações específicas da plataforma (veja abaixo)
`tags`	array	Não	Tags de conteúdo (`[{ "value": "id", "label": "name" }]`)
`shortLink`	boolean	Não	Habilitar encurtamento de URL e rastreamento de cliques

Configurações específicas por plataforma

Inclua estas em posts[].settings para recursos específicos de cada plataforma: TikTok:

{
  "tiktok": {
    "title": "Video title",
    "privacy_level": "PUBLIC_TO_EVERYONE",
    "duet": true,
    "stitch": true,
    "comment": true
  }
}

YouTube:

{
  "youtube": {
    "title": "Video title",
    "type": "public",
    "tags": [{ "value": "tag1", "label": "Tag 1" }]
  }
}

Instagram:

{
  "instagram": {
    "post_type": "post",
    "collaborators": [{ "label": "@username" }]
  }
}

LinkedIn:

{
  "linkedin": {
    "post_as_images_carousel": true
  }
}

Resposta

Retorna um array com uma entrada por post criado:

[
  {
    "postId": "post-uuid",
    "channel": { "id": "channel-uuid" }
  }
]

Listar posts

GET /public/v1/posts

Recupere posts dentro de um intervalo de datas.

Requisição

curl -H "Authorization: YOUR_API_KEY" \
  "https://api.postzee.app/public/v1/posts?startDate=2026-04-01T00:00:00Z&endDate=2026-04-30T23:59:59Z"

Parâmetros de consulta

Parâmetro	Tipo	Obrigatório	Descrição
`startDate`	string	Sim	Data de início (ISO 8601)
`endDate`	string	Sim	Data de fim (ISO 8601)
`customer`	string	Não	Filtrar por ID de cliente

Resposta

{
  "posts": [
    {
      "id": "post-uuid",
      "content": "Conteúdo do post...",
      "state": "PUBLISHED",
      "releaseId": "17895695668004550",
      "releaseURL": "https://www.instagram.com/p/Cabc123/",
      "publishDate": "2026-04-15T14:00:00Z",
      "channel": {
        "id": "channel-uuid",
        "platform": "instagram",
        "name": "My Instagram",
        "picture": "https://..."
      }
    }
  ]
}

Status do post

GET /public/v1/posts/:id

Recupere o status de publicação de um único post. Como a publicação é assíncrona, use este endpoint para fazer poll de um post após criá-lo: assim que state for PUBLISHED, a resposta traz o ID do post na plataforma (releaseId) e o permalink público (releaseURL).

Requisição

curl -H "Authorization: YOUR_API_KEY" \
  https://api.postzee.app/public/v1/posts/post-uuid-here

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string (path)	Sim	O ID do post retornado por Criar post

Resposta

{
  "id": "post-uuid",
  "state": "PUBLISHED",
  "published": true,
  "releaseId": "17895695668004550",
  "releaseURL": "https://www.instagram.com/p/Cabc123/",
  "publishDate": "2026-04-15T14:00:00Z",
  "createdAt": "2026-04-15T13:58:00Z",
  "channel": {
    "id": "channel-uuid",
    "platform": "instagram",
    "name": "My Instagram"
  }
}

Campo	Descrição
`state`	`QUEUE` (aguardando publicação), `PUBLISHED`, `ERROR` ou `DRAFT`
`published`	`true` quando `state` é `PUBLISHED`
`releaseId`	O ID nativo do post na plataforma (ex.: o ID da mídia no Instagram). `null` até ser publicado
`releaseURL`	O permalink público do post. `null` até ser publicado

A publicação acontece em segundo plano, então logo após Criar post o estado é QUEUE e releaseId é null. Faça poll deste endpoint (ou use um webhook) até state ser PUBLISHED para ler o releaseId.

Excluir post

DELETE /public/v1/posts/:id

Exclua um post pelo ID.

Requisição

curl -X DELETE \
  -H "Authorization: YOUR_API_KEY" \
  https://api.postzee.app/public/v1/posts/post-uuid-here

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string (path)	Sim	O ID do post a ser excluído

Resposta

Retorna 200 OK em caso de sucesso.

Excluir um post publicado o remove do Postzee, mas não o remove da plataforma de rede social. Para remover conteúdo publicado, você deve excluí-lo diretamente na plataforma.

Encontrar melhor horário

GET /public/v1/find-slot/:id

Encontre o horário menos congestionado para publicação.

Requisição

curl -H "Authorization: YOUR_API_KEY" \
  https://api.postzee.app/public/v1/find-slot/channel-uuid

Resposta

{
  "date": "2026-05-01T10:00:00Z"
}

Retorna uma sugestão de data e hora UTC quando seu calendário está menos ocupado.

Visão Geral

Endpoints

Criar post

Requisição

Parâmetros

Configurações específicas por plataforma

Resposta

Listar posts

Requisição

Parâmetros de consulta

Resposta

Status do post

Requisição

Parâmetros

Resposta

Excluir post

Requisição

Parâmetros

Resposta

Encontrar melhor horário

Requisição

Resposta

​Criar post

​Requisição

​Parâmetros

​Configurações específicas por plataforma

​Resposta

​Listar posts

​Requisição

​Parâmetros de consulta

​Resposta

​Status do post

​Requisição

​Parâmetros

​Resposta

​Excluir post

​Requisição

​Parâmetros

​Resposta

​Encontrar melhor horário

​Requisição

​Resposta

Criar post

Requisição

Parâmetros

Configurações específicas por plataforma

Resposta

Listar posts

Requisição

Parâmetros de consulta

Resposta

Status do post

Requisição

Parâmetros

Resposta

Excluir post

Requisição

Parâmetros

Resposta

Encontrar melhor horário

Requisição

Resposta