contacts.participations

Participações do contato. Bloco Participações: envios em massa que o contato recebeu (broadcasts, nome = modelo ou início do texto), execuções de automação (flows), pipelines em que tem oportunidade (pipelines, uma linha por pipeline com a oportunidade mais recente; value em centavos) e listas manuais (lists). count é o total; items traz até 50, mais recentes primeiro.

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

Entrada

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

Exemplo

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

CLI:

node cli/atomiks.mjs contacts.participations --json '{"contactId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta contacts_participations com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "broadcasts": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "sentAt": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "status": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "sentAt",
              "status"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "count",
        "items"
      ],
      "additionalProperties": false
    },
    "flows": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "runId": {
                "type": "string"
              },
              "flowId": {
                "type": "string"
              },
              "flowName": {
                "type": "string"
              },
              "status": {
                "type": "string",
                "enum": [
                  "active",
                  "waiting",
                  "completed",
                  "failed",
                  "cancelled",
                  "suppressed"
                ]
              },
              "startedAt": {
                "type": "string"
              }
            },
            "required": [
              "runId",
              "flowId",
              "flowName",
              "status",
              "startedAt"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "count",
        "items"
      ],
      "additionalProperties": false
    },
    "pipelines": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "pipelineId": {
                "type": "string"
              },
              "pipelineName": {
                "type": "string"
              },
              "stageName": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "value": {
                "type": [
                  "number",
                  "null"
                ]
              }
            },
            "required": [
              "pipelineId",
              "pipelineName",
              "stageName",
              "status",
              "value"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "count",
        "items"
      ],
      "additionalProperties": false
    },
    "lists": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "count",
        "items"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "broadcasts",
    "flows",
    "pipelines",
    "lists"
  ],
  "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).