Skip to main content
PATCH
Update organization profile

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Body

application/json
name
string
Required string length: 1 - 120
Maximum string length: 160
country
string
Required string length: 2
currency
string
Required string length: 1 - 8
offsiteReasons
string[]
Maximum array length: 20
Required string length: 1 - 60

Response

200 - application/json

Success

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
name
string
required
country
string
required
currency
string
required
fyStartMonth
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
fyStartLabel
string
required
offsiteReasons
string[]
required