Obtener una marca

Nombre	Tipo	Obligatorio	Descripción
brandId	string	obligatorio	Brand UUID, the `socialProfile.id` returned by POST /social/brands or the `id` of a row from GET /social/brands.

Nombre

Tipo

Obligatorio

Descripción

brandId

string

obligatorio

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

Respuestas

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`).

Obtiene una sola marca por su UUID. El contenido de la respuesta es idéntico al de una fila de GET /social/brands, así que utiliza esta operación cuando ya tengas un brandId y quieras la copia más reciente en lugar de volver a obtener la lista.

Caso de uso: mostrar el encabezado de la marca en una pantalla de publicación. Lee profileName y logo para identificar la marca en el editor de publicaciones, y timezone.tzCode para mostrar las horas programadas en la zona horaria en la que la API realmente las interpretará. Una publicación programada con scheduleDate + scheduleTime se temporiza según este campo, por lo que mostrar al lector cualquier otra zona horaria puede provocar errores de varias horas.

Caso de uso: comprobación previa a la publicación. Si connectedChannelCount es 0, no hay dónde publicar. Dirige al usuario a un enlace de conexión en lugar de permitirle redactar una publicación que se rechazará con SY95045.

Notas.

brandId es un UUID sin codificar. Codificarlo en Base64, como harías con un ID de ubicación, produce un 404.
brandId es únicamente un token de ruta. El mismo valor aparece en los cuerpos de las solicitudes como socialProfileId; los dos nombres corresponden al mismo ID en distintas posiciones.
archived es true para una marca que ya se ha archivado. Una marca cuyo archivado solo está programado sigue mostrando archived: false; consulta archivar una marca.
timezone.tzCode es el identificador IANA que se utiliza para interpretar las horas programadas; los otros tres campos de zona horaria son etiquetas de visualización.
Para obtener las conexiones individuales de la marca —sus plataformas y sus ID de conexión—, llama a GET /social/brands/{brandId}/connections.

Parámetros

Ruta

Respuestas