PATCH
/
v1
/
organizations
/
{organization_id}
Update an Organization
curl --request PATCH \
  --url http://127.0.0.1:3000/v1/organizations/{organization_id} \
  --header 'Content-Type: <content-type>' \
  --data '"{\n  \"legalName\": \"Hilll - Hessel\",\n  \"parentOrganizationId\": \"e1ed3a74-654a-4b44-ad7d-37a9fac46d71\",\n  \"doingBusinessAs\": \"The ledger.io\",\n  \"status\": {\n      \"code\": \"BLOCKED\",\n      \"description\": \"Teste Blocked\"\n  },\n  \"address\": {\n      \"line1\": \"Avenida Paulista, 1234\",\n      \"line2\": \"CJ 203\",\n      \"zipCode\": \"04696040\",\n      \"city\": \"São Paulo\",\n      \"state\": \"São Paulo\",\n      \"country\": \"Brasil\"\n  },\n  \"metadata\": {\n      \"chave\": \"metadata_chave_update\",\n      \"bitcoinn\": \"randomBitcoin\",\n      \"boolean\": true,\n      \"double\": 10.5,\n      \"int\": 1\n  }\n}"'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "legalName": "<string>",
  "parentOrganizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "doingBusinessAs": "<string>",
  "legalDocument": "<string>",
  "status": {
    "status": {
      "description": "<string>",
      "code": "<string>"
    }
  },
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>"
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
ImportantKeep 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

​
Content-Type
string
required

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

​
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.

Body

application/json
​
legalName
string
required

The legal name of the Organization.

Maximum length: 256
​
parentOrganizationId
string<uuid> | null

The unique identifier of the parent Organization.

​
doingBusinessAs
string | null

The trade name of the Organization.

Maximum length: 256
​
legalDocument
string

The document of the Organization.

Maximum length: 256
​
status
object

An object containing information about the status.

​
address
object

An object containing information about the address of the Organization.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field <code>name</code> is the key and the field <code>value</code> 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 Organization.

​
legalName
string

The legal name of the Organization.

Maximum length: 256
​
parentOrganizationId
string<uuid> | null

The unique identifier of the parent Organization.

​
doingBusinessAs
string | null

The trade name of the Organization.

Maximum length: 256
​
legalDocument
string

The document of the Organization.

Maximum length: 256
​
status
object

An object containing information about the status.

​
address
object

An object containing information about the address of the Organization.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field <code>name</code> is the key and the field <code>value</code> 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).