Ver .md

attendants.set_types

Definir os tipos de um atendente. Troca o conjunto de tipos do atendente por attendantTypeIds (lista vazia tira todos). Devolve o atendente atualizado.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
attendantTypeIdsstring (uuid)[]sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "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)$"
    },
    "attendantTypeIds": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "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": [
    "id",
    "attendantTypeIds"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/attendants.set_types \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","attendantTypeIds":["00000000-0000-0000-0000-000000000000"]}'

CLI:

node cli/atomiks.mjs attendants.set_types --json '{"id":"00000000-0000-0000-0000-000000000000","attendantTypeIds":["00000000-0000-0000-0000-000000000000"]}'

MCP: ferramenta attendants_set_types com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "initials": {
      "type": "string"
    },
    "imageUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "color": {
      "type": [
        "string",
        "null"
      ]
    },
    "role": {
      "type": "string",
      "enum": [
        "admin",
        "user"
      ]
    },
    "createdAt": {
      "type": "string"
    },
    "meetingRoomUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "types": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "emoji": {
            "type": [
              "string",
              "null"
            ]
          },
          "color": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "emoji",
          "color"
        ],
        "additionalProperties": false
      }
    },
    "pipelines": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "additionalProperties": false
      }
    },
    "stats": {
      "type": "object",
      "properties": {
        "opportunities": {
          "type": "number"
        },
        "openOpportunities": {
          "type": "number"
        },
        "wonOpportunities": {
          "type": "number"
        },
        "lostOpportunities": {
          "type": "number"
        },
        "wonValueCents": {
          "type": "number"
        },
        "commissionCents": {
          "type": [
            "number",
            "null"
          ]
        },
        "meetingsScheduled": {
          "type": "number"
        },
        "meetingsCompleted": {
          "type": "number"
        },
        "conversion": {
          "type": [
            "number",
            "null"
          ]
        }
      },
      "required": [
        "opportunities",
        "openOpportunities",
        "wonOpportunities",
        "lostOpportunities",
        "wonValueCents",
        "commissionCents",
        "meetingsScheduled",
        "meetingsCompleted",
        "conversion"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "name",
    "initials",
    "imageUrl",
    "color",
    "role",
    "createdAt",
    "meetingRoomUrl",
    "types",
    "pipelines",
    "stats"
  ],
  "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).