Update a segment

{ "createdAt": "2021-01-01T00:00:00Z", "deletedAt": "2021-01-01T00:00:00Z", "id": "00000000-0000-0000-0000-000000000000", "ledgerId": "00000000-0000-0000-0000-000000000000", "name": "My Segment", "organizationId": "00000000-0000-0000-0000-000000000000", "status": { "code": "ACTIVE", "description": "Active status" }, "updatedAt": "2021-01-01T00:00:00Z", "metadata": {} }

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

string

required

Segment ID (UUID)

Body

application/json

metadata

object

required

Show child attributes

name

string

required

Example:

"My Segment Updated"

status

object

required

Show child attributes

Response

createdAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time> | null

required

Example:

"2021-01-01T00:00:00Z"

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

ledgerId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

name

string

required

Maximum string length: 256

Example:

"My Segment"

organizationId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

status

object

required

Show child attributes

updatedAt

string<date-time>

required

Example:

"2021-01-01T00:00:00Z"

metadata

object

Show child attributes

Getting started

Current (v2)

Compatibility (v1)

Error handling

Update a segment

Authorizations

Path Parameters

Body

Response