Ver .md

roles.delete

Exclui um cargo. Cargos fixos não saem. Quem tinha o cargo passa a ter só os outros; sem nenhum outro, mantém o acesso atual.

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

Entrada

CampoTipoObrigatórioNota
idstringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs roles.delete --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta roles_delete 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"
    }
  },
  "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).