Skip to main content
PATCH
/
v1
/
organizations
/
{org_id}
Update Organization
curl --request PATCH \
  --url https://api.letpiper.com/v1/organizations/{org_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "business_information": "<string>",
  "timezone": "<string>"
}
'
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_information": "<string>",
  "timezone": "<string>",
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required

Body

application/json

Schema for updating an organization.

​
name
string | null
Required string length: 1 - 255
​
business_information
string | null
Maximum string length: 10000
​
timezone
string | null

Response

Successful Response

Schema for reading organization data (response).

​
name
string
required
Required string length: 1 - 255
​
id
string<uuid>
required
​
business_information
string | null
required
​
timezone
string
required
​
created_by_user_id
string<uuid>
required
​
owner_user_id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required