OrbitSenderDocs
ReferenceSegmentos

Criar segmento

POST
/api/external/create-segment

Cria um segmento com um ou mais canais e grupos. Os grupos devem existir nos canais informados.

Authorization

ApiKeyAuth
api-key<token>

Chave de API no formato sk_live_....

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/external/create-segment" \  -H "Content-Type: application/json" \  -d '{    "name": "Clientes VIP",    "id_channel": [      "ch_token_1",      "ch_token_2"    ],    "groups": [      "120363021234567890@g.us",      "120363021234567891@g.us"    ]  }'
{  "success": true,  "id_segment": "string",  "name": "string",  "total_groups": 0,  "timestamp": "2019-08-24T14:15:22Z"}
{  "success": false,  "error": "Bad Request",  "message": "O campo \"name\" é obrigatório no body da requisição."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "message": "Limite de canais atingido.",  "current": 5,  "max": 5}
{  "success": false,  "error": "Not Found",  "message": "Segmento não encontrado."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}
{  "success": false,  "error": "Service Unavailable",  "message": "Não foi possível consultar os grupos. Tente novamente em instantes."}