Ver .md

contacts.avatar_set

Trocar a foto do contato. Põe como foto do contato uma imagem enviada antes por POST /api/v1/uploads (kind image; o próprio membro que enviou). Aceita JPEG, PNG ou WebP até 5 MB. A foto posta à mão não é trocada pela sincronização do WhatsApp ou do Instagram. Devolve a URL da foto.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/contacts.avatar_set (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:write
  • Grava dados: sim
  • Pela chave de API: sim
  • Ferramenta MCP: contacts_avatar_set
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId contacts.avatar_set)

Entrada

CampoTipoObrigatórioNota
contactIdstring (uuid)sim
uploadIdstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactId": {
      "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)$"
    },
    "uploadId": {
      "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": [
    "contactId",
    "uploadId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs contacts.avatar_set --json '{"contactId":"00000000-0000-0000-0000-000000000000","uploadId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta contacts_avatar_set com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "avatarUrl": {
      "type": "string"
    }
  },
  "required": [
    "avatarUrl"
  ],
  "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).