Listings APIListings API
Entrar
POST/api/v4/social/posts/cancel

Cancelar uma publicação agendada

Cancela uma publicação agendada em redes sociais antes que ela seja publicada, sem alterar as publicações já realizadas.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Corpo

NomeTipoObrigatórioDescrição
inputobjectobrigatórioWrapper object. The entire request body must be nested under `input`.
input.socialPostIdstringobrigatórioUUID of the scheduled post to cancel.

Exemplo de requisição

Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.

Request body
{  "input": {    "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"  }}

Respostas

200The scheduled post was cancelled and will not publish.
Response
{  "data": {    "archiveScheduledPost": {      "success": true,      "error": null,      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
200The post was not in a cancellable state, most often because it has already published. The status is still 200: read `success`.
Response
{  "data": {    "archiveScheduledPost": {      "success": false,      "error": {        "message": "SY90006: Post is not scheduled and cannot be cancelled",        "code": "SY90006",        "contextInfo": null      },      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
401Unauthenticated, missing or invalid API key.
404No post with that ID on this account.

Cancela uma publicação que ainda está aguardando para ser publicada. A publicação passa para ARCHIVED e o pipeline de publicação a descarta. Rascunhos podem ser cancelados da mesma forma; publicações que já foram publicadas não podem.

Caso de uso: um cliente retira uma campanha de última hora. Seu calendário mostra uma publicação agendada, o cliente muda de ideia e você a cancela pela sua própria interface. Obtenha o id da publicação diretamente da lista de publicações da marca e chame este endpoint; a linha passa para ARCHIVED e deixa de aparecer em um filtro de {"status":["SCHEDULED"]} na próxima leitura.

Caso de uso: limpeza antes de desconectar um canal. Desconectar uma conexão não cancela as publicações já enfileiradas para ela — em vez disso, elas falham no momento da publicação com SY95045. Cancele primeiro as publicações agendadas e depois desconecte, e o cliente não verá nenhuma falha.

Observações.

  • O corpo da requisição deve estar encapsulado em um objeto input.
  • Verifique success, não o status HTTP. Uma publicação que já foi publicada ou que já foi cancelada retorna HTTP 200 com success: false.
  • Isto não é uma exclusão. Nada é removido de nenhuma plataforma. Uma publicação que já foi publicada permanece no ar, e esta chamada apenas informa success: false para ela. Não existe um endpoint que retire do ar uma publicação em redes sociais; a remoção é feita na própria plataforma.
  • O cancelamento se aplica a todos os canais da publicação ou a nenhum deles. Não é possível cancelar uma publicação agendada em uma plataforma e permitir que ela seja publicada em outra; crie publicações separadas se precisar disso.
  • A publicação continua disponível para leitura depois disso com GET /social/posts/{postId}, com post.status igual a ARCHIVED.

Operação de escrita: não executada na conta em produção. A requisição e a resposta mostradas são construídas a partir do esquema da API.

Request
curl -X POST 'https://listingsapi.com/api/v4/social/posts/cancel' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }'
Run in playground