api_keys.update

Editar chave de API. Troca o nome e os escopos de uma chave ativa da conta atual. Vale na próxima requisição da chave; o segredo não muda. Uma chave não passa de comum para administração (nem o contrário): crie outra.

• Endpoint: POST https://app.atomiks.com.br/api/v1/api_keys.update (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: nenhum (qualquer chave serve)
• Grava dados: sim
• Pela chave de API: não (só pela interface)
• Ferramenta MCP: não
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId api_keys.update)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "scopes": {
      "minItems": 1,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "account:read",
          "account:write",
          "team:read",
          "team:write",
          "activity:read",
          "admin:read",
          "admin:write",
          "channels:read",
          "channels:write",
          "contacts:read",
          "ads:read",
          "ads:write",
          "messages:read",
          "messages:send",
          "messages:manage",
          "crm:read",
          "crm:write",
          "conversions:read",
          "conversions:write",
          "automations:read",
          "automations:write",
          "marketing:read",
          "marketing:write"
        ]
      }
    }
  },
  "required": [
    "id",
    "name",
    "scopes"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/api_keys.update \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000","name":"Integração","scopes":["team:read","messages:read"]}'

Saída

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

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