Update a segment

Metadata is applied as an RFC 7396 merge patch: a body without metadata, or with an empty metadata object, leaves the stored metadata as it is; a key sent as null is deleted; any other key is added or replaced; metadata sent as null also leaves the stored metadata as it is, so keys are deleted one at a time.

PATCH /v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id}

Update a segment

cURL

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id}/ledgers/{ledger_id}/segments/{segment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {},
  "name": "My Segment Updated"
}
'

200

{
  "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)

segment_id · string · required

Segment ID (UUID)

Body

application/json

metadata · object

Show child attributes

name · string

Example:

"My Segment Updated"

status · object

Show child attributes

Response

200

application/json

OK

createdAt · string<date-time> · required

Example:

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

deletedAt · string<date-time> | null · required

Example:

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

id · 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