Saltar al contenido principal
Crear un Segmento
curl --request POST \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments \
  --header 'Content-Type: <content-type>' \
  --data '{
  "name": "Segmento VIP",
  "status": {
    "code": "ACTIVE",
    "description": "Segmento activo y disponible para asignación"
  },
  "metadata": {
    "categoria": "Clientes",
    "origen": "Sistema CRM",
    "ambiente": "producción"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": {
    "status": {
      "description": "<string>",
      "code": "<string>"
    }
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser <code>application/json</code>.

​
X-Request-Id
string

Identificador único usado para rastrear y seguir cada solicitud.

Path Parameters

​
organization_id
string
required

Identificador único de la organización asociada con el ledger.

​
ledger_id
string
required

Identificador único del ledger asociado.

Body

application/json
​
name
string
required

Nombre del segmento.

Maximum length: 256
​
status
object

Objeto que contiene información sobre el estado. Importante: Si no se proporciona, el estado predeterminado será 'ACTIVE'.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo <code>name</code> es la clave y el campo <code>value</code> es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

Response

Indica que la solicitud se realizó correctamente y que la respuesta contiene los datos esperados.

​
id
string<uuid>

Identificador único del segmento.

​
organizationId
string<uuid>

Identificador único de la organización.

​
ledgerId
string<uuid>

Identificador único del ledger.

​
name
string

Nombre del segmento.

Maximum length: 256
​
status
object

Objeto que contiene información sobre el estado.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo <code>name</code> es la clave y el campo <code>value</code> es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Marca temporal de creación (UTC).

​
updatedAt
string<date-time>

Marca temporal de la última actualización (UTC).

​
deletedAt
string<date-time> | null

Marca temporal de eliminación lógica, si aplica (UTC).