StatusDesenvolvedoresParceirosPTENESEntrar
Falar com vendasCriar conta grátis
Criar conta grátis
Falar com vendasCriar conta grátis
EntrarStatusPTENES

Referência da API

Segmentos

Crie segmentos dinâmicos por tag, atributo, opt-in, canal ou última interação, veja a contagem e uma amostra antes de salvar e edite os já salvos.

  • 6 operações
  • URL basehttps://api.messages.ccxcompany.co
  • AutenticaçãoBearer com a sua chave de API

O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.

List saved segments

GET/v2/segments

Returns the org's saved segments (dynamic contact lists). Supports name search + pagination.

Parâmetros

CampoOndeTipoDescrição
qopcionalquerystringFilter segments by name substring.
limitopcionalqueryintegerPage size (default 50).
skipopcionalqueryintegerOffset for pagination.

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    JSON
    {}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/segments' \  -H "Authorization: Bearer $CCX_API_KEY"
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Create a saved segment

POST/v2/segments

Persists a named, filter-based dynamic list. filters is an AND-joined array of leaf conditions (tag / attribute / optIn / lastInteraction / channel); at least one is required.

For nested AND/OR logic, send the recursive filterTree instead — when present it takes precedence over filters.

Corpo da requisiçãoapplication/json

CampoTipoDescrição
nameobrigatóriostring
descriptionopcionalstring
filtersobrigatórioobject[]
filters[].fieldopcionalstringValores:channel
filters[].operatoropcionalstringValores:has
filters[].valueopcionalstringValores:whatsappemail
filters[].keyopcionalstring
filterTreeopcionalobject
filterTree.kindopcionalstringValores:group
filterTree.filteropcionalobject
filterTree.filter.fieldopcionalstringValores:channel
filterTree.filter.operatoropcionalstringValores:has
filterTree.filter.valueopcionalstringValores:whatsappemail
filterTree.filter.keyopcionalstring
filterTree.operatoropcionalstringValores:andor
filterTree.nodesopcionalany[]
Exemplo completo do corpo
JSON
{  "name": "string",  "description": "string",  "filters": [    {      "field": "tag",      "operator": "is",      "value": "string"    }  ],  "filterTree": {    "kind": "leaf",    "filter": {      "field": "tag",      "operator": "is",      "value": "string"    }  }}

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    JSON
    {}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 409RFC 7807 problem details for CONFLICT (409).

  • 422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl -X POST 'https://api.messages.ccxcompany.co/v2/segments' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "filters": [      {        "field": "tag",        "operator": "is",        "value": "string"      }    ]  }'
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Get a saved segment

GET/v2/segments/{segmentId}

Returns a single segment by id. Cross-tenant ids return 404.

Parâmetros

CampoOndeTipoDescrição
segmentIdobrigatóriocaminhostringSegment id (seg_…).

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    JSON
    {}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 404RFC 7807 problem details for NOT_FOUND (404).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl 'https://api.messages.ccxcompany.co/v2/segments/<segmentId>' \  -H "Authorization: Bearer $CCX_API_KEY"
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Update a saved segment

PATCH/v2/segments/{segmentId}

Partial update. Any of name, description, filters, filterTree may be sent; omitted fields are unchanged.

Parâmetros

CampoOndeTipoDescrição
segmentIdobrigatóriocaminhostringSegment id (seg_…).

Corpo da requisiçãoapplication/json

CampoTipoDescrição
nameopcionalstring
descriptionopcionalstring
filtersopcionalobject[]
filters[].fieldopcionalstringValores:channel
filters[].operatoropcionalstringValores:has
filters[].valueopcionalstringValores:whatsappemail
filters[].keyopcionalstring
filterTreeopcionalobject
filterTree.kindopcionalstringValores:group
filterTree.filteropcionalobject
filterTree.filter.fieldopcionalstringValores:channel
filterTree.filter.operatoropcionalstringValores:has
filterTree.filter.valueopcionalstringValores:whatsappemail
filterTree.filter.keyopcionalstring
filterTree.operatoropcionalstringValores:andor
filterTree.nodesopcionalany[]
Exemplo completo do corpo
JSON
{  "name": "string",  "description": "string",  "filters": [    {      "field": "tag",      "operator": "is",      "value": "string"    }  ],  "filterTree": {    "kind": "leaf",    "filter": {      "field": "tag",      "operator": "is",      "value": "string"    }  }}

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    JSON
    {}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 404RFC 7807 problem details for NOT_FOUND (404).

  • 409RFC 7807 problem details for CONFLICT (409).

  • 422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl -X PATCH 'https://api.messages.ccxcompany.co/v2/segments/<segmentId>' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{}'
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Delete a saved segment

DELETE/v2/segments/{segmentId}

Hard delete. Returns 204 with no body.

Parâmetros

CampoOndeTipoDescrição
segmentIdobrigatóriocaminhostringSegment id (seg_…).

Respostas

  • 204Default Response

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 404RFC 7807 problem details for NOT_FOUND (404).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl -X DELETE 'https://api.messages.ccxcompany.co/v2/segments/<segmentId>' \  -H "Authorization: Bearer $CCX_API_KEY"
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Preview a segment (count + sample) without persisting

POST/v2/segments/preview

Evaluate a tentative filter set and get back the match count + a sample of contact ids, without saving a segment. Same filters / filterTree shape as create.

Corpo da requisiçãoapplication/json

CampoTipoDescrição
filtersobrigatórioobject[]
filters[].fieldopcionalstringValores:channel
filters[].operatoropcionalstringValores:has
filters[].valueopcionalstringValores:whatsappemail
filters[].keyopcionalstring
filterTreeopcionalobject
filterTree.kindopcionalstringValores:group
filterTree.filteropcionalobject
filterTree.filter.fieldopcionalstringValores:channel
filterTree.filter.operatoropcionalstringValores:has
filterTree.filter.valueopcionalstringValores:whatsappemail
filterTree.filter.keyopcionalstring
filterTree.operatoropcionalstringValores:andor
filterTree.nodesopcionalany[]
Exemplo completo do corpo
JSON
{  "filters": [    {      "field": "tag",      "operator": "is",      "value": "string"    }  ],  "filterTree": {    "kind": "leaf",    "filter": {      "field": "tag",      "operator": "is",      "value": "string"    }  }}

Respostas

  • 200Default Response

    Campos e exemplo da resposta
    JSON
    {}

  • 401RFC 7807 problem details for UNAUTHORIZED (401).

  • 403RFC 7807 problem details for FORBIDDEN (403).

  • 422RFC 7807 problem details for VALIDATION_ERROR (422).

As respostas de erro seguem o formato RFC 7807 (application/problem+json), com um código estável no campo code. Ver os códigos de erro

Exemplo em curl

cURL
curl -X POST 'https://api.messages.ccxcompany.co/v2/segments/preview' \  -H "Authorization: Bearer $CCX_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "filters": [      {        "field": "tag",        "operator": "is",        "value": "string"      }    ]  }'
Só os campos obrigatórios. Troque os valores de exemplo pelos seus.

Outras áreas da API

Travou em alguma rota? Fale com quem mantém a API.

Criar conta grátisFalar com vendas

Criando a conta pelo site, você ganha R$ 10 de crédito de teste.