Skip to main content
PUT
/
api
/
organization
Update organization information
curl --request PUT \
  --url https://api.example.com/api/organization \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "name": "Acme Inc.",
  "industry": "Technology",
  "location": "US",
  "baseCurrency": "USD",
  "timezone": "America/New_York",
  "fiscalYear": "January",
  "language": "en-US",
  "dateFormat": "MM/DD/YYYY",
  "address": {
    "address_1": "123 Main St",
    "address_2": "Suite 100",
    "postal_code": "10001",
    "city": "New York",
    "stateProvince": "NY",
    "phone": "+1-555-123-4567"
  },
  "primaryColor": "#4285F4",
  "logoKey": "organizations/acme-logo-123456.png",
  "taxNumber": "12-3456789"
}
'

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
name
string

Organization name

Example:

"Acme Inc."

​
industry
string

Industry of the organization

Example:

"Technology"

​
location
string

Country location in ISO 3166-1 alpha-2 format

Example:

"US"

​
baseCurrency
string

Base currency in ISO 4217 format

Example:

"USD"

​
timezone
string

Timezone of the organization

Example:

"America/New_York"

​
fiscalYear
string

Starting month of fiscal year

Example:

"January"

​
language
string

Language/locale of the organization

Example:

"en-US"

​
dateFormat
string

Date format used by the organization

Example:

"MM/DD/YYYY"

​
address
object

Organization address details

Example:
{
  "address_1": "123 Main St",
  "address_2": "Suite 100",
  "postal_code": "10001",
  "city": "New York",
  "stateProvince": "NY",
  "phone": "+1-555-123-4567"
}
​
primaryColor
string

Primary brand color in hex format

Example:

"#4285F4"

​
logoKey
string

Logo file key reference

Example:

"organizations/acme-logo-123456.png"

​
taxNumber
string

Organization tax identification number

Example:

"12-3456789"

Response

200

Organization information has been updated successfully