Skip to content

SAC

Endpoints para integração de atendimento e gestão de tickets (SAC).

Base URL das rotas: /api/customerSupports

Autenticação obrigatória em todas as rotas:

bash
Authorization: Bearer <SEU_TOKEN>

Listar boards

GET /api/customerSupports/boards

Retorna a lista de boards do SAC da empresa

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/boards" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
[
  null
]

Códigos de Resposta

CódigoDescrição
200Lista de boards
401Não autorizado

Criar card

POST /api/customerSupports/cards

Cria um novo card (ticket) de atendimento

Corpo da Requisição

json
{
  "client_id": "00000000-0000-0000-0000-000000000000",
  "customer_support_board_list_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "channel": "string",
  "priority": "lowest",
  "due_date": "2026-01-01T00:00:00.000Z",
  "description": "string",
  "customer_support_custom_fields": [
    {}
  ]
}

Campos do Corpo

CampoTipoObrigatórioDescrição
client_idstringNãoID do cliente
customer_support_board_list_idstringSimID da lista onde o card será criado
user_idstringNãoID do usuário responsável
channelstringSimCanal de origem (ex: whatsapp, email, telefone)
prioritystringSimPrioridade do atendimento Valores permitidos: lowest, low, medium, high, highest.
due_datestringNãoData de vencimento
descriptionstringNãoDescrição do atendimento
customer_support_custom_fieldsarray de objetosNãoCampos personalizados

Exemplo de Requisição

bash
curl -X POST "https://api-b2s.experienciab2s.com/api/customerSupports/cards" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "client_id": "00000000-0000-0000-0000-000000000000",
  "customer_support_board_list_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "channel": "string",
  "priority": "lowest",
  "due_date": "2026-01-01T00:00:00.000Z",
  "description": "string",
  "customer_support_custom_fields": [
    {}
  ]
}'

Resposta de Sucesso (201)

json
null

Códigos de Resposta

CódigoDescrição
201Card criado com sucesso
400Dados inválidos
401Não autorizado

Obter card

GET /api/customerSupports/cards/{id}

Retorna os detalhes de um card específico

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do card

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/cards/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Detalhes do card
401Não autorizado
404Card não encontrado

Atualizar card

PUT /api/customerSupports/cards/{id}

Atualiza um card existente

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do card

Corpo da Requisição

json
{
  "channel": "string",
  "priority": "lowest",
  "due_date": "2026-01-01T00:00:00.000Z",
  "description": "string",
  "user_id": "00000000-0000-0000-0000-000000000000"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
channelstringNãoCanal de origem
prioritystringNãoPrioridade Valores permitidos: lowest, low, medium, high, highest.
due_datestringNãoData de vencimento
descriptionstringNãoDescrição
user_idstringNãoID do responsável

Exemplo de Requisição

bash
curl -X PUT "https://api-b2s.experienciab2s.com/api/customerSupports/cards/{id}" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "channel": "string",
  "priority": "lowest",
  "due_date": "2026-01-01T00:00:00.000Z",
  "description": "string",
  "user_id": "00000000-0000-0000-0000-000000000000"
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Card atualizado com sucesso
401Não autorizado
404Card não encontrado

Excluir card

DELETE /api/customerSupports/cards/{id}

Remove um card

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do card

Exemplo de Requisição

bash
curl -X DELETE "https://api-b2s.experienciab2s.com/api/customerSupports/cards/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (204)

Sem corpo de resposta.

Códigos de Resposta

CódigoDescrição
204Card removido com sucesso
401Não autorizado
404Card não encontrado

Arquivar/Desarquivar card

PUT /api/customerSupports/cards/{id}/archived

Altera o status de arquivamento de um card

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do card

Corpo da Requisição

json
{
  "archived": false
}

Campos do Corpo

CampoTipoObrigatórioDescrição
archivedbooleanSimtrue para arquivar, false para desarquivar

Exemplo de Requisição

bash
curl -X PUT "https://api-b2s.experienciab2s.com/api/customerSupports/cards/{id}/archived" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "archived": false
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Status de arquivamento atualizado
401Não autorizado
404Card não encontrado

Mover card entre listas

PATCH /api/customerSupports/cards/{id}/move

Move um card de uma lista para outra

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do card

Corpo da Requisição

json
{
  "customer_support_board_list_id": "00000000-0000-0000-0000-000000000000",
  "old_customer_support_board_list_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
customer_support_board_list_idstringSimID da lista de destino
old_customer_support_board_list_idstringSimID da lista de origem
user_idstringNãoID do usuário que realizou a movimentação

Exemplo de Requisição

bash
curl -X PATCH "https://api-b2s.experienciab2s.com/api/customerSupports/cards/{id}/move" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "customer_support_board_list_id": "00000000-0000-0000-0000-000000000000",
  "old_customer_support_board_list_id": "00000000-0000-0000-0000-000000000000",
  "user_id": "00000000-0000-0000-0000-000000000000"
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Card movido com sucesso
401Não autorizado
404Card ou lista não encontrada

Listar cards com paginação

GET /api/customerSupports/cards/pagination

Retorna uma lista paginada de cards com filtros

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
limitintegerSimNúmero de registros por página
offsetintegerSimPágina atual
order_columnstringSimColuna para ordenação
order_typestringSimDireção da ordenação
searchstringNãoTermo de busca
date_startstringNãoData inicial de criação
date_endstringNãoData final de criação
channelstringNãoFiltrar por canal
due_date_startstringNãoData inicial de vencimento
due_date_endstringNãoData final de vencimento
prioritystringNãoFiltrar por prioridade
user_idstringNãoFiltrar por responsável
customer_support_board_list_idstringNãoFiltrar por lista
archivedbooleanNãoFiltrar por status de arquivamento

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/cards/pagination?limit=valor&offset=valor&order_column=valor&order_type=valor" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Lista paginada de cards
401Não autorizado

Criar comentário

POST /api/customerSupports/comments

Adiciona um novo comentário a um card

Corpo da Requisição

json
{
  "customer_support_board_card_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "user_id": "00000000-0000-0000-0000-000000000000"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
customer_support_board_card_idstringSimID do card
contentstringSimConteúdo do comentário
user_idstringNãoID do usuário autor do comentário

Exemplo de Requisição

bash
curl -X POST "https://api-b2s.experienciab2s.com/api/customerSupports/comments" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "customer_support_board_card_id": "00000000-0000-0000-0000-000000000000",
  "content": "string",
  "user_id": "00000000-0000-0000-0000-000000000000"
}'

Resposta de Sucesso (201)

json
null

Códigos de Resposta

CódigoDescrição
201Comentário criado com sucesso
400Dados inválidos
401Não autorizado

Listar comentários de um card

GET /api/customerSupports/comments/{customer_support_board_card_id}

Retorna todos os comentários de um card específico

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
customer_support_board_card_idstringSimID do card

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/comments/{customer_support_board_card_id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
[
  null
]

Códigos de Resposta

CódigoDescrição
200Lista de comentários
401Não autorizado
404Card não encontrado

Atualizar comentário

PATCH /api/customerSupports/comments/{id}

Atualiza o conteúdo de um comentário

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do comentário

Corpo da Requisição

json
{
  "content": "string"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
contentstringSimNovo conteúdo do comentário

Exemplo de Requisição

bash
curl -X PATCH "https://api-b2s.experienciab2s.com/api/customerSupports/comments/{id}" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "content": "string"
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Comentário atualizado com sucesso
401Não autorizado
404Comentário não encontrado

Excluir comentário

DELETE /api/customerSupports/comments/{id}

Remove um comentário

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do comentário

Exemplo de Requisição

bash
curl -X DELETE "https://api-b2s.experienciab2s.com/api/customerSupports/comments/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (204)

Sem corpo de resposta.

Códigos de Resposta

CódigoDescrição
204Comentário removido com sucesso
401Não autorizado
404Comentário não encontrado

Listar campos personalizados

GET /api/customerSupports/customFields

Retorna a lista de campos personalizados de um board

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
board_idstringSimID do board

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/customFields?board_id=valor" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
[
  null
]

Códigos de Resposta

CódigoDescrição
200Lista de campos personalizados
401Não autorizado

Criar campo personalizado

POST /api/customerSupports/customFields

Cria um novo campo personalizado para um board

Corpo da Requisição

json
{
  "customer_support_board_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "type": "string",
  "required": false,
  "position": 0
}

Campos do Corpo

CampoTipoObrigatórioDescrição
customer_support_board_idstringSimID do board
namestringSimNome do campo
typestringSimTipo do campo (text, number, date, select, etc.)
requiredbooleanSimIndica se o campo é obrigatório
positionintegerSimPosição do campo no formulário

Exemplo de Requisição

bash
curl -X POST "https://api-b2s.experienciab2s.com/api/customerSupports/customFields" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "customer_support_board_id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "type": "string",
  "required": false,
  "position": 0
}'

Resposta de Sucesso (201)

json
null

Códigos de Resposta

CódigoDescrição
201Campo personalizado criado com sucesso
400Dados inválidos
401Não autorizado

Obter campo personalizado

GET /api/customerSupports/customFields/{id}

Retorna os detalhes de um campo personalizado específico

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do campo personalizado

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/customFields/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Detalhes do campo personalizado
401Não autorizado
404Campo não encontrado

Atualizar campo personalizado

PUT /api/customerSupports/customFields/{id}

Atualiza um campo personalizado existente

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do campo personalizado

Corpo da Requisição

json
{
  "name": "string",
  "type": "string",
  "required": false,
  "position": 0
}

Campos do Corpo

CampoTipoObrigatórioDescrição
namestringNãoNome do campo
typestringNãoTipo do campo
requiredbooleanNãoIndica se o campo é obrigatório
positionintegerNãoPosição do campo

Exemplo de Requisição

bash
curl -X PUT "https://api-b2s.experienciab2s.com/api/customerSupports/customFields/{id}" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "type": "string",
  "required": false,
  "position": 0
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Campo atualizado com sucesso
401Não autorizado
404Campo não encontrado

Excluir campo personalizado

DELETE /api/customerSupports/customFields/{id}

Remove um campo personalizado

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do campo personalizado

Exemplo de Requisição

bash
curl -X DELETE "https://api-b2s.experienciab2s.com/api/customerSupports/customFields/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (204)

Sem corpo de resposta.

Códigos de Resposta

CódigoDescrição
204Campo removido com sucesso
401Não autorizado
404Campo não encontrado

Alternar status do campo personalizado

PATCH /api/customerSupports/customFields/status/{id}

Ativa ou desativa um campo personalizado

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID do campo personalizado

Exemplo de Requisição

bash
curl -X PATCH "https://api-b2s.experienciab2s.com/api/customerSupports/customFields/status/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Status atualizado com sucesso
401Não autorizado
404Campo não encontrado

Listar histórico de um card

GET /api/customerSupports/histories/{customer_support_board_card_id}

Retorna o histórico de alterações de um card específico

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
customer_support_board_card_idstringSimID do card

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/histories/{customer_support_board_card_id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
[
  null
]

Códigos de Resposta

CódigoDescrição
200Lista de históricos
401Não autorizado
404Card não encontrado

Criar lista

POST /api/customerSupports/lists

Cria uma nova lista em um board

Corpo da Requisição

json
{
  "name": "string",
  "customer_support_board_id": "00000000-0000-0000-0000-000000000000",
  "status": "pending"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
namestringSimNome da lista
customer_support_board_idstringSimID do board
statusstringNãoStatus da lista Valores permitidos: pending, in-progress, done.

Exemplo de Requisição

bash
curl -X POST "https://api-b2s.experienciab2s.com/api/customerSupports/lists" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "customer_support_board_id": "00000000-0000-0000-0000-000000000000",
  "status": "pending"
}'

Resposta de Sucesso (201)

json
null

Códigos de Resposta

CódigoDescrição
201Lista criada com sucesso
400Dados inválidos
401Não autorizado

Atualizar posições das listas

PATCH /api/customerSupports/lists/{customer_support_board_id}/positions

Atualiza a ordem das listas em um board

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
customer_support_board_idstringSimID do board

Corpo da Requisição

json
{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Campos do Corpo

CampoTipoObrigatórioDescrição
idsarray de stringsSimArray de IDs das listas na nova ordem

Exemplo de Requisição

bash
curl -X PATCH "https://api-b2s.experienciab2s.com/api/customerSupports/lists/{customer_support_board_id}/positions" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}'

Resposta de Sucesso (200)

Sem corpo de resposta.

Códigos de Resposta

CódigoDescrição
200Posições atualizadas com sucesso
401Não autorizado

Obter lista

GET /api/customerSupports/lists/{id}

Retorna os detalhes de uma lista específica

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID da lista

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/lists/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Detalhes da lista
401Não autorizado
404Lista não encontrada

Atualizar lista

PATCH /api/customerSupports/lists/{id}

Atualiza uma lista existente

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID da lista

Corpo da Requisição

json
{
  "name": "string",
  "status": "pending"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
namestringNãoNome da lista
statusstringNãoStatus da lista Valores permitidos: pending, in-progress, done.

Exemplo de Requisição

bash
curl -X PATCH "https://api-b2s.experienciab2s.com/api/customerSupports/lists/{id}" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "string",
  "status": "pending"
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Lista atualizada com sucesso
401Não autorizado
404Lista não encontrada

Excluir lista

DELETE /api/customerSupports/lists/{id}

Remove uma lista

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID da lista

Exemplo de Requisição

bash
curl -X DELETE "https://api-b2s.experienciab2s.com/api/customerSupports/lists/{id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (204)

Sem corpo de resposta.

Códigos de Resposta

CódigoDescrição
204Lista removida com sucesso
401Não autorizado
404Lista não encontrada

Arquivar/Desarquivar lista

PATCH /api/customerSupports/lists/{id}/archive

Altera o status de arquivamento de uma lista

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
idstringSimID da lista

Corpo da Requisição

json
{
  "archived": false
}

Campos do Corpo

CampoTipoObrigatórioDescrição
archivedbooleanSimtrue para arquivar, false para desarquivar

Exemplo de Requisição

bash
curl -X PATCH "https://api-b2s.experienciab2s.com/api/customerSupports/lists/{id}/archive" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "archived": false
}'

Resposta de Sucesso (200)

json
null

Códigos de Resposta

CódigoDescrição
200Status de arquivamento atualizado
401Não autorizado
404Lista não encontrada

Listar listas de um board

GET /api/customerSupports/lists/board/{customer_support_board_id}

Retorna todas as listas de um board específico

Parâmetros de Caminho

ParâmetroTipoObrigatórioDescrição
customer_support_board_idstringSimID do board

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/customerSupports/lists/board/{customer_support_board_id}" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
[
  null
]

Códigos de Resposta

CódigoDescrição
200Lista de listas do board
401Não autorizado
404Board não encontrado

Setup inicial de listas

POST /api/customerSupports/lists/setup

Cria a configuração inicial de listas padrão para um board

Corpo da Requisição

json
{
  "customer_support_board_id": "00000000-0000-0000-0000-000000000000"
}

Campos do Corpo

CampoTipoObrigatórioDescrição
customer_support_board_idstringSimID do board

Exemplo de Requisição

bash
curl -X POST "https://api-b2s.experienciab2s.com/api/customerSupports/lists/setup" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
  "customer_support_board_id": "00000000-0000-0000-0000-000000000000"
}'

Resposta de Sucesso (201)

json
[
  null
]

Códigos de Resposta

CódigoDescrição
201Setup realizado com sucesso
401Não autorizado

Documentação oficial de integrações da plataforma Falaê.