attendants.update
Editar um atendente. Altera o nome de exibição (name; null volta ao nome do perfil) e a sala de reunião (meetingRoomUrl, link http/https; vazio ou null limpa). Só o que for enviado muda. Exige a migration de atendentes (migration_pendente sem ela).
- Endpoint:
POST https://app.atomiks.com.br/api/v1/attendants.update(corpo JSON) - Quem pode chamar: administrador da conta
- Escopo da chave:
crm:write - Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP:
attendants_update - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdattendants.update)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
id | string (uuid) | sim | |
name | string | null | não | |
meetingRoomUrl | string | null | não |
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)$"
},
"name": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 120
},
{
"type": "null"
}
]
},
"meetingRoomUrl": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "null"
}
]
}
},
"required": [
"id"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/attendants.update \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"id":"00000000-0000-0000-0000-000000000000","meetingRoomUrl":"https://meet.google.com/abc-defg-hij"}'CLI:
node cli/atomiks.mjs attendants.update --json '{"id":"00000000-0000-0000-0000-000000000000","meetingRoomUrl":"https://meet.google.com/abc-defg-hij"}'MCP: ferramenta attendants_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": {
"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).