channel_connections.profile_get

Ver o perfil comercial de um número de WhatsApp. O perfil que os clientes veem no WhatsApp (whatsapp_business_profile da Graph): sobre, descrição, endereço, e-mail, categoria, sites e foto, mais o nome de exibição e se um novo nome está em revisão. Só número da API oficial. coexistence diz que o número usa o app WhatsApp Business: a foto é do app e o nome passa por revisão manual.

• Endpoint: POST https://app.atomiks.com.br/api/v1/channel_connections.profile_get (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: channels:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: channel_connections_profile_get
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId channel_connections.profile_get)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "channelId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "channelId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/channel_connections.profile_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"channelId":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs channel_connections.profile_get --json '{"channelId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta channel_connections_profile_get com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "about": {
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "address": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "vertical": {
      "type": [
        "string",
        "null"
      ]
    },
    "websites": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "profilePictureUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "displayName": {
      "type": [
        "string",
        "null"
      ]
    },
    "nameUnderReview": {
      "type": "boolean"
    },
    "coexistence": {
      "type": "boolean"
    }
  },
  "required": [
    "about",
    "description",
    "address",
    "email",
    "vertical",
    "websites",
    "profilePictureUrl",
    "displayName",
    "nameUnderReview",
    "coexistence"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).