Listings APIListings API
Entrar
DELETE/api/v4/posts/{postId}

Excluir uma publicação

Exclui permanentemente uma campanha de publicação em redes sociais e a remove de todos os sites em que foi publicada.

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

Parâmetros

Caminho

NomeTipoObrigatórioDescrição
postIdstringobrigatórioBase64-encoded social post ID to delete (the `id` from a posts list or the create response).

Corpo

NomeTipoObrigatórioDescrição
clientMutationIdstringopcionalOptional client-supplied token returned unchanged in the response, for correlating the request.

Exemplo de requisição

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

Request body
{  "clientMutationId": "delete-44122-req-1"}

Respostas

200Post deleted. `socialPostId` returns the deleted post's ID.
Response
{  "data": {    "deleteSocialPost": {      "success": true,      "socialPostId": "U29jaWFsUG9zdDo0NDEyMg=="    }  }}
401Unauthenticated, missing or invalid API key.

Exclui a campanha de publicação especificada. Essa ação é permanente: a publicação é removida da Listings API e retirada de todos os sites em que foi publicada (Google, Facebook). Excluir uma publicação ativa a remove dos perfis conectados; não é possível desfazer essa ação.

Caso de uso: retirar um anúncio incorreto. Se um anúncio foi publicado com horários incorretos, exclua-o com DELETE /posts/{postId} (usando o id da lista de publicações), confirme success: true e publique um anúncio corrigido com POST /posts. Para remover uma campanha de todas as lojas de uma só vez, exclua a campanha em massa pelo ID em massa dela.

Observações.

  • O corpo da requisição é opcional. Envie clientMutationId somente se você quiser que o valor seja retornado sem alterações para correlacionar requisições; o trecho de código gerado o inclui como exemplo.
  • Uma publicação cujo período programado já terminou pode apresentar status: EXPIRED e não estar mais ativa em cada site, mas excluí-la ainda a remove da Listings API.
  • Excluir uma publicação já excluída ou desconhecida retorna uma resposta de erro ({"data":null,"errors":[...]}) em vez de success: true.

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

Request
curl -X DELETE 'https://listingsapi.com/api/v4/posts/<postId>' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "clientMutationId": "delete-44122-req-1"  }'
Run in playground