Skip to main content
PATCH
/
orgunits
/
{id}
Partial update org unit
curl --request PATCH \
  --url https://api.piriod.com/orgunits/{id}/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-simple-workspace: <x-simple-workspace>' \
  --data '
{
  "customer": "<string>",
  "name": "<string>"
}
'
{
  "customer": "<string>",
  "name": "<string>",
  "id": 123,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use header Authorization: Token <api_token>. API tokens are obtained from the Piriod dashboard.

Headers

​
x-simple-workspace
string
required

Workspace (account) identifier. Required for every request.

​
x-piriod-test-mode
boolean
default:false

Whether to operate against test-mode data. Defaults to false.

Path Parameters

​
id
string
required

Resource identifier.

Body

application/json
​
customer
string
required
​
name
string
required
Maximum string length: 64

Response

Updated org unit.

​
customer
string
required

Customer ID this org unit belongs to.

​
name
string
required
Maximum string length: 64
​
id
integer
read-only
​
created
string<date-time>
read-only
​
updated
string<date-time>
read-only