Ver .md

attendants.availability_set

Definir a disponibilidade semanal de um atendente. Troca o fuso e todas as faixas semanais do atendente (lista vazia = indisponível a semana toda). Faixas válidas têm início antes do fim e não se sobrepõem no mesmo dia; senão invalid_input. O próprio atendente ou um administrador. Exige a migration de disponibilidade (migration_pendente sem ela).

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
timezonestringsim
slotsobject[]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)$"
    },
    "timezone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "slots": {
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dayOfWeek": {
            "type": "integer",
            "minimum": 0,
            "maximum": 6
          },
          "startTime": {
            "type": "string",
            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
          },
          "endTime": {
            "type": "string",
            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
          }
        },
        "required": [
          "dayOfWeek",
          "startTime",
          "endTime"
        ]
      }
    }
  },
  "required": [
    "id",
    "timezone",
    "slots"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/attendants.availability_set \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","timezone":"America/Sao_Paulo","slots":[{"dayOfWeek":1,"startTime":"09:00","endTime":"17:00"}]}'

CLI:

node cli/atomiks.mjs attendants.availability_set --json '{"id":"00000000-0000-0000-0000-000000000000","timezone":"America/Sao_Paulo","slots":[{"dayOfWeek":1,"startTime":"09:00","endTime":"17:00"}]}'

MCP: ferramenta attendants_availability_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": {
    "attendantId": {
      "type": "string"
    },
    "timezone": {
      "type": [
        "string",
        "null"
      ]
    },
    "slots": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "dayOfWeek": {
            "type": "integer",
            "minimum": 0,
            "maximum": 6
          },
          "startTime": {
            "type": "string",
            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
          },
          "endTime": {
            "type": "string",
            "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
          }
        },
        "required": [
          "dayOfWeek",
          "startTime",
          "endTime"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "attendantId",
    "timezone",
    "slots"
  ],
  "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).