ReadMe_OptInListV2Response

Lista paginada de opt-ins

opts object[]

Opt-ins encontrados

Lista [

optInIdstring<uuid>

Identificador único do opt-in

Exemplo fe2cc560-036c-44cd-90e8-294d5a74cebc

companyTaxIdstring

CPF ou CNPJ da empresa

Exemplo 12345678000195

statusstring

Status do opt-in

Valores possíveis: [CREATION_PENDING, REGISTRATION_REQUESTED, RETRY_CREATION, CREATION_FAILED, CREATION_TIMEOUT, CANCELLED, CREATED, DELETION_PENDING, DELETION_FAILED, DELETED, DELETED_INACTIVE, DELETION_INACTIVE_PENDING, DELETION_INACTIVE_FAILED]

Exemplo CREATED

scheduleEnabledboolean

Indica se a recorrência está habilitada

Exemplo true

createdAtstring<date-time>aceita valor nulo

Data de criação do opt-in em UTC

Exemplo 2026-04-17T12:30:00Z

updatedAtstring<date-time>aceita valor nulo

Data da última atualização do opt-in em UTC

Exemplo 2026-04-17T13:00:00Z

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

]

pagination object

Metadados de paginação baseada em cursor

currentItemstring

ID do item atual (primeiro da página)

Exemplo fe2cc560-036c-44cd-90e8-294d5a74cebc

limitinteger<int32>

Número de itens por página

Exemplo 30

nextItemstringaceita valor nulo

ID do próximo item (cursor para a próxima página)

Exemplo 22222222-2222-4222-8222-222222222222

totalItemsinteger<int64>

Total de itens disponíveis

Exemplo 150

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

ReadMe_OptInListV2Response

{
  "opts": [
    {
      "optInId": "fe2cc560-036c-44cd-90e8-294d5a74cebc",
      "companyTaxId": "12345678000195",
      "status": "CREATED",
      "scheduleEnabled": true,
      "createdAt": "2026-04-17T12:30:00Z",
      "updatedAt": "2026-04-17T13:00:00Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "/api/v2/companies",
          "description": "Cadastre a empresa para o cliente"
        }
      ]
    }
  ],
  "pagination": {
    "currentItem": "fe2cc560-036c-44cd-90e8-294d5a74cebc",
    "limit": 30,
    "nextItem": "22222222-2222-4222-8222-222222222222",
    "totalItems": 150
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}