AtomiksAPI
Ver .md

custom_objects.links_opportunity_badges

Selos de objetos nos cards de oportunidade. Para cada oportunidade de opportunityIds (até 200), os registros ligados por ligações com showOnCard ligado: {opportunityId, relationId, recordId, title, objectId, icon, color, label} (label é o nome da ligação do lado da oportunidade). É o selo do card no kanban.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/custom_objects.links_opportunity_badges (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: custom_objects_links_opportunity_badges
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId custom_objects.links_opportunity_badges)

Entrada

CampoTipoObrigatórioNota
opportunityIdsstring (uuid)[]sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "opportunityIds": {
      "minItems": 1,
      "maxItems": 200,
      "type": "array",
      "items": {
        "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)$"
      }
    }
  },
  "required": [
    "opportunityIds"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs custom_objects.links_opportunity_badges --json '{"opportunityIds":["00000000-0000-0000-0000-000000000000"]}'

MCP: ferramenta custom_objects_links_opportunity_badges com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "opportunityId": {
            "type": "string"
          },
          "relationId": {
            "type": "string"
          },
          "recordId": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "objectId": {
            "type": "string"
          },
          "icon": {
            "type": "string"
          },
          "color": {
            "type": "string"
          },
          "label": {
            "type": "string"
          }
        },
        "required": [
          "opportunityId",
          "relationId",
          "recordId",
          "title",
          "objectId",
          "icon",
          "color",
          "label"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "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).

custom_objects.links_opportunity_badges · Atomiks API