OrbitSenderDocs
ReferenceSegmentos

Editar segmento

PUT
/api/external/edit-segment/{id_segment}

Atualiza parcialmente um segmento. Envie ao menos um dos campos.

Authorization

ApiKeyAuth
api-key<token>

Chave de API no formato sk_live_....

In: header

Path Parameters

id_segment*string

Token do segmento.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Properties1 <= properties

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/external/edit-segment/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "success": true,  "message": "string",  "id_segment": "string",  "name": "string",  "total_groups": 0}
{  "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."}