Listas

Crie e gerencie listas (etiquetas) para segmentar contatos, e associe/desassocie contatos em lote. A remoção é soft delete (a lista fica inativa). Todos os endpoints exigem plano Enterprise.

GET/api/v1/lists

escopo: tags:readEnterprise

Lista as listas ativas da empresa.

Resposta (200)

Corpo da resposta

{
  "success": true,
  "data": [
    {
      "id": "<uuid>",
      "name": "VIP",
      "color": "#6366f1",
      "description": "Clientes VIP",
      "display_order": 1,
      "is_active": true,
      "created_at": "2026-07-01T14:00:00.000Z"
    }
  ]
}

Exemplo

curl

curl -s -H "Authorization: Bearer <sua-key>" https://www.prosalab.com/api/v1/lists

POST/api/v1/lists

escopo: tags:writeEnterprise

Cria uma lista. Nome duplicado (entre listas ativas) retorna 409; um nome antes removido é reativado.

Modelo de envio

Corpo da requisição

{
  "name": "VIP",
  "color": "#6366f1",
  "description": "Clientes VIP"
}

Resposta (201)

Corpo da resposta

{
  "success": true,
  "data": {
    "list": {
      "id": "<uuid>",
      "name": "VIP",
      "color": "#6366f1",
      "description": "Clientes VIP",
      "display_order": 3,
      "is_active": true,
      "created_at": "2026-07-16T18:00:00.000Z"
    }
  }
}

Erros

Status	Código	Quando ocorre
409	LIST_EXISTS	Já existe lista ativa com este nome nesta empresa

Exemplo

curl

curl -s -X POST -H "Authorization: Bearer <sua-key>" -H "Content-Type: application/json" \
  -d '{"name":"VIP","color":"#6366f1","description":"Clientes VIP"}' \
  https://www.prosalab.com/api/v1/lists

PATCH/api/v1/lists/{id}

escopo: tags:writeEnterprise

Renomeia ou recolore uma lista.

Modelo de envio

Corpo da requisição

{
  "name": "VIP 2026"
}

Resposta (200)

Corpo da resposta

{
  "success": true,
  "data": {
    "list": {
      "id": "<uuid>",
      "name": "VIP 2026",
      "color": "#6366f1",
      "description": "Clientes VIP",
      "display_order": 3,
      "is_active": true,
      "created_at": "2026-07-16T18:00:00.000Z"
    }
  }
}

Erros

Status	Código	Quando ocorre
404	NOT_FOUND	Lista não existe ou pertence a outra empresa
409	LIST_EXISTS	Novo nome já usado por outra lista ativa da empresa

Exemplo

curl

curl -s -X PATCH -H "Authorization: Bearer <sua-key>" -H "Content-Type: application/json" \
  -d '{"name":"VIP 2026"}' \
  https://www.prosalab.com/api/v1/lists/{id}

DELETE/api/v1/lists/{id}

escopo: tags:writeEnterprise

Desativa a lista (soft delete — idempotente).

Resposta (200)

Corpo da resposta

{
  "success": true,
  "data": {
    "id": "<uuid>"
  }
}

Erros

Status	Código	Quando ocorre
404	NOT_FOUND	Lista não existe ou pertence a outra empresa

Exemplo

curl

curl -s -X DELETE -H "Authorization: Bearer <sua-key>" https://www.prosalab.com/api/v1/lists/{id}

POST/api/v1/lists/{id}/contacts

escopo: tags:writeEnterprise

Associa contatos à lista em lote (até 500 por chamada).

contact_ids que não pertencem à empresa contam como not_found (não é erro fatal).

Modelo de envio

Corpo da requisição

{
  "contact_ids": [
    "<uuid>",
    "<uuid>"
  ]
}

Resposta (200)

Corpo da resposta

{
  "success": true,
  "data": {
    "added": 2,
    "already_present": 0,
    "not_found": 0
  }
}

Erros

Status	Código	Quando ocorre
404	NOT_FOUND	Lista não existe ou pertence a outra empresa

Exemplo

curl

curl -s -X POST -H "Authorization: Bearer <sua-key>" -H "Content-Type: application/json" \
  -d '{"contact_ids":["<uuid>","<uuid>"]}' \
  https://www.prosalab.com/api/v1/lists/{id}/contacts

DELETE/api/v1/lists/{id}/contacts

escopo: tags:writeEnterprise

Remove contatos da lista em lote (até 500 por chamada).

Modelo de envio

Corpo da requisição

{
  "contact_ids": [
    "<uuid>"
  ]
}

Resposta (200)

Corpo da resposta

{
  "success": true,
  "data": {
    "removed": 1
  }
}

Erros

Status	Código	Quando ocorre
404	NOT_FOUND	Lista não existe ou pertence a outra empresa

Exemplo

curl

curl -s -X DELETE -H "Authorization: Bearer <sua-key>" -H "Content-Type: application/json" \
  -d '{"contact_ids":["<uuid>"]}' \
  https://www.prosalab.com/api/v1/lists/{id}/contacts