Ver .md

channel_connections.profile_update

Editar o perfil comercial de um número de WhatsApp. Grava na Meta (POST /{phone_number_id}/whatsapp_business_profile) só os campos enviados: about (até 139), description (até 512), address (até 256), email, vertical (categoria) e websites (até 2, com https). Texto vazio apaga o campo. Devolve o perfil atualizado.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/channel_connections.profile_update (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: channels:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: channel_connections_profile_update
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId channel_connections.profile_update)

Entrada

CampoTipoObrigatórioNota
channelIdstring (uuid)sim
aboutstringnão
descriptionstringnão
addressstringnão
email"" | string (email)não
vertical"" | "AUTO" | "BEAUTY" | "APPAREL" | "EDU" | "ENTERTAIN" | "EVENT_PLAN" | "FINANCE" | "GROCERY" | "GOVT" | "HOTEL" | "HEALTH" | "NONPROFIT" | "PROF_SERVICES" | "RETAIL" | "TRAVEL" | "RESTAURANT" | "OTHER"não
websitesstring[]não
JSON Schema
{
  "$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)$"
    },
    "about": {
      "type": "string",
      "maxLength": 139
    },
    "description": {
      "type": "string",
      "maxLength": 512
    },
    "address": {
      "type": "string",
      "maxLength": 256
    },
    "email": {
      "anyOf": [
        {
          "type": "string",
          "const": ""
        },
        {
          "type": "string",
          "maxLength": 128,
          "format": "email",
          "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
        }
      ]
    },
    "vertical": {
      "anyOf": [
        {
          "type": "string",
          "const": ""
        },
        {
          "type": "string",
          "enum": [
            "AUTO",
            "BEAUTY",
            "APPAREL",
            "EDU",
            "ENTERTAIN",
            "EVENT_PLAN",
            "FINANCE",
            "GROCERY",
            "GOVT",
            "HOTEL",
            "HEALTH",
            "NONPROFIT",
            "PROF_SERVICES",
            "RETAIL",
            "TRAVEL",
            "RESTAURANT",
            "OTHER"
          ]
        }
      ]
    },
    "websites": {
      "maxItems": 2,
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 256
      }
    }
  },
  "required": [
    "channelId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs channel_connections.profile_update --json '{"channelId":"00000000-0000-0000-0000-000000000000","description":"Loja de roupas"}'

MCP: ferramenta channel_connections_profile_update 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).

channel_connections.profile_update · Atomiks API