Update an existing organization

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}

Update an existing organization

cURL

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v2/organizations/{organization_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "doingBusinessAs": "Lerian Group",
  "legalName": "Lerian Financial Group Ltd.",
  "metadata": {},
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

200

{
  "address": {
    "city": "New York",
    "country": "US",
    "line1": "123 Financial Avenue",
    "line2": "Suite 1500",
    "state": "NY",
    "zipCode": "10001",
    "description": "Home"
  },
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "doingBusinessAs": "Lerian FS",
  "id": "00000000-0000-0000-0000-000000000000",
  "legalDocument": "123456789012345",
  "legalName": "Lerian Financial Services Ltd.",
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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)

Body

application/json

address · object

Show child attributes

doingBusinessAs · string | null

Maximum string length: 256

Example:

"Lerian Group"

legalName · string

Maximum string length: 256

Example:

"Lerian Financial Group Ltd."

metadata · object

Show child attributes

parentOrganizationId · string<uuid> | null

status · object

Show child attributes

Response

200

application/json

OK

address · object · required

Show child attributes

createdAt · string<date-time> · required

Example:

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

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

Example:

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

doingBusinessAs · string | null · required

Maximum string length: 256

Example:

"Lerian FS"

id · string<uuid> · required

Example:

"00000000-0000-0000-0000-000000000000"

legalDocument · string · required

Maximum string length: 256

Example:

"123456789012345"

legalName · string · required

Maximum string length: 256

Example:

"Lerian Financial Services Ltd."

parentOrganizationId · string<uuid> | null · required

status · object · required

Show child attributes

updatedAt · string<date-time> · required

Example:

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

metadata · object

Show child attributes