Obter uma marca

Nome	Tipo	Obrigatório	Descrição
brandId	string	obrigatório	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Nome

Tipo

Obrigatório

Descrição

brandId

string

obrigatório

Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Respostas

200The brand.

Response

{  "data": {    "getSocialProfileDetails": {      "id": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "profileName": "Jenny Home",      "archived": false,      "logo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "profileLogo": "https://cdn.listingsapi.com/social/brands/6f2c9a41/logo.png",      "siteUrl": "https://jennyhome.example",      "countryIso": "US",      "bio": "Handmade furniture for real homes.",      "businessIntent": "A family-run home furnishings store selling handmade furniture and textiles.",      "categories": ["Furniture Store", "Home Goods"],      "brandHashtags": ["jennyhome", "handmadefurniture"],      "competitorHashtags": ["localfurniture"],      "connectedChannelCount": 3,      "timezone": {        "label": "(GMT-05:00) Eastern Time",        "tzCode": "America/New_York",        "name": "Eastern Standard Time",        "utc": "-05:00"      },      "contentPreferredLanguage": "en"    }  }}

401Unauthenticated, missing or invalid API key.

404No brand with that ID on this account (`SY95043`).

Busca uma única marca pelo UUID. O conteúdo retornado é idêntico a uma linha de GET /social/brands, então use esta operação quando você já tiver um brandId e quiser a versão mais recente, em vez de listar novamente.

Caso de uso: exibir o cabeçalho da marca em uma tela de publicação. Leia profileName e logo para identificar a marca no editor de publicações, e timezone.tzCode para exibir os horários agendados no fuso em que a API realmente os interpretará. Uma publicação agendada com scheduleDate + scheduleTime tem seu horário definido com base neste campo, portanto, mostrar qualquer outra informação ao leitor pode causar erros de várias horas.

Caso de uso: verificação prévia à publicação. Se connectedChannelCount for 0, não há onde publicar. Direcione o usuário para um link de conexão em vez de permitir que ele escreva uma publicação que será rejeitada com SY95045.

Observações.

brandId é um UUID simples. Codificá-lo em Base64, como você faria com um ID de local, resulta em um 404.
brandId é um token usado apenas no caminho. O mesmo valor aparece nos corpos das requisições como socialProfileId; os dois nomes representam o mesmo ID em posições diferentes.
archived é true para uma marca que já foi arquivada. Uma marca cujo arquivamento está apenas agendado ainda apresenta archived: false — consulte arquivar uma marca.
timezone.tzCode é o identificador IANA usado como referência para determinar os horários dos agendamentos; os outros três campos de fuso horário são rótulos de exibição.
Para obter as conexões individuais da marca — suas plataformas e IDs de conexão —, chame GET /social/brands/{brandId}/connections.

Parâmetros

Caminho

Respostas