Skip to main content
Update a Segment
curl --request PATCH \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} \
  --header 'Content-Type: <content-type>' \
  --data '{
  "name": "Premium Retail Segment - Updated",
  "status": {
    "code": "BLOCKED",
    "description": "Segment temporarily blocked due to policy changes"
  },
  "metadata": {
    "minMonthlyIncome": 12000,
    "creditScoreThreshold": 760,
    "tier": "Platinum",
    "fxEnabled": true,
    "overdraftEligibility": false,
    "dailyTransferLimit": 60000,
    "segmentationSource": "internal_scoring_engine",
    "notes": "Segment updated based on revised KYC criteria"
  }
}'
{
  "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"
}
Keep the following in mind when updating the metadata object:
  • If no metadata is provided, the existing metadata will remain unchanged.
  • Sending an empty metadata object will remove all current metadata.
  • Sending a metadata object with values will overwrite all existing metadata, so be sure to include any pre-existing data you want to retain.

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

​
segment_id
string
required

The unique identifier of the segment that you want to retrieve, delete or update.

Body

application/json
​
name
string
required

The name of the Segment.

Maximum length: 256
​
status
object

An object containing information about the status. Important: If not provided, the default status will be 'ACTIVE'.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Response

Indicates that the request was successful and the response contains the expected data.

​
id
string<uuid>

The unique identifier of the Segment.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
name
string

The name of the Segment.

Maximum length: 256
​
status
object

An object containing information about the status.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).