Listings APIListings API
Entrar
POST/api/v4/social/brands/archive

Arquivar uma marca

Arquiva a marca social após 90 dias de permanência, desativa conexões imediatamente e retém as vagas até o fim do período de cobrança.

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.socialProfileIdstringobrigatórioUUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Exemplo de requisição

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

Request body
{  "input": {    "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"  }}

Respostas

200Brand archived. Its connections are archived with it and go offline at once, but their slots stay counted against `maxConnections` until the billing period ends.
Response
{  "data": {    "archiveSocialProfile": {      "success": true,      "error": null,      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "ARCHIVED"    }  }}
200The brand is less than 90 days old and cannot be archived yet. `success` is `false` and `status` is `TENURE_NOT_MET`.
Response
{  "data": {    "archiveSocialProfile": {      "success": false,      "error": {        "message": "SY95051: Brand must be at least 90 days old before it can be archived",        "code": "SY95051",        "contextInfo": null      },      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "TENURE_NOT_MET"    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Arquiva uma marca. O arquivamento é imediato: depois que a marca estiver na conta por pelo menos 90 dias, esta chamada arquiva a marca e todas as contas sociais conectadas a ela na mesma requisição, e essas contas param de publicar imediatamente.

Caso de uso: planejar a capacidade do próximo ciclo. As marcas em si são ilimitadas e não têm uso contabilizado, portanto o arquivamento não diz respeito à quantidade de marcas — diz respeito às conexões. Se um cliente deixou de usar o serviço, arquivar a marca dele coloca seus canais offline hoje e programa a disponibilização de suas vagas na renovação, que é o que usage.connectionsReleased em GET /social/limits informa. Se você precisar da capacidade antes disso, compre um pacote de conexões — essa é a única alteração que entra em vigor imediatamente.

Valores de status na resposta:

  • ARCHIVED: a marca e suas conexões foram arquivadas. Este é o único resultado de sucesso.
  • TENURE_NOT_MET: a marca tem menos de 90 dias e ainda não pode ser arquivada. success é false, error.code é SY95051, e a marca permanece inalterada.

Notas.

  • O corpo da requisição deve estar encapsulado em um objeto input, e o campo é socialProfileId, não brandId.
  • Verifique success, não o status HTTP. Uma falha no requisito de permanência é um HTTP 200 com success: false, status: "TENURE_NOT_MET" e SY95051 em error.
  • Uma marca deve ter pelo menos 90 dias para ser arquivada. Essa é a mesma regra aplicada aos locais; consulte Planos e complementos. Tente novamente após o 90º dia da marca; não há como dispensar esse requisito pela API.
  • Arquivar uma marca arquiva suas conexões. Todas as contas sociais vinculadas à marca são desconectadas na mesma operação, e GET /social/limits reflete isso na próxima leitura com um valor menor de usage.connectionsActive e um valor maior de usage.connectionsReleased. O valor faturável de usage.connections permanece inalterado até a mudança de período.
  • Não há nada a cancelar na marca. O arquivamento em si não espera o fim de um ciclo de cobrança, portanto não há um estado agendado nem uma chamada de cancelamento para ele. O que é adiado é a consequência no faturamento: as vagas de conexão liberadas, assim como um pacote complementar cancelado, voltam a ficar disponíveis quando o ciclo termina.

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

Request
curl -X POST 'https://listingsapi.com/api/v4/social/brands/archive' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"    }  }'
Run in playground