Ver .md

segmentation.list_update

Editar nome e emoji da lista. Muda o nome e/ou o emoji (null tira o emoji). Campos omitidos não mudam.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
namestringnão
emojistring | nullnã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": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "emoji": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 16
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs segmentation.list_update --json '{"id":"00000000-0000-0000-0000-000000000000","name":"Clientes VIP"}'

MCP: ferramenta segmentation_list_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"
    },
    "emoji": {
      "type": [
        "string",
        "null"
      ]
    },
    "leadCount": {
      "type": "number"
    },
    "updatedAt": {
      "type": "string"
    },
    "createdAt": {
      "type": "string"
    },
    "source": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "name",
    "emoji",
    "leadCount",
    "updatedAt",
    "createdAt",
    "source"
  ],
  "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).