Ver .md

crm.product_archive

Arquivar produto. Arquiva (archived: true) ou restaura o produto. Vendas e oportunidades antigas continuam apontando para ele.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
archivedbooleansim
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)$"
    },
    "archived": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "archived"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs crm.product_archive --json '{"id":"00000000-0000-0000-0000-000000000000","archived":true}'

MCP: ferramenta crm_product_archive 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"
    },
    "kind": {
      "type": "string",
      "enum": [
        "physical",
        "digital",
        "service"
      ]
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "priceCents": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "imageUrl": {
      "type": [
        "string",
        "null"
      ]
    },
    "archived": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "kind",
    "name",
    "description",
    "priceCents",
    "imageUrl",
    "archived"
  ],
  "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).