Skip to main content
PATCH
/
organisations
/
{id}
Update an organisation
curl --request PATCH \
  --url https://{subdomain}.nudj.cx/api/v2/admin/organisations/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "name": "<string>",
  "language": "<string>",
  "timezone": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "language": "<string>",
  "timezone": "<string>",
  "location": "DE",
  "createdBy": "<string>",
  "updatedBy": "<string>"
}

Authorizations

x-api-token
string
header
required

Path Parameters

id
string
required

The id of the organisation

Body

application/json

The input required to update an organisation

name
string

The name of the organisation

language
string

The language of the organisation e.g. en, de, fr, etc.

timezone
string

The timezone of the organisation (IANA format)

Response

Successful response

id
string
required

The id of the organisation

name
string
required

The name of the organisation

language
string
required

The language of the organisation e.g. en, de, fr, etc.

timezone
string
required

The timezone of the organisation (IANA format)

location
enum<string>
required

The location of data for the organisation

Available options:
DE,
US
createdBy
string
required

The user who created this organisation

updatedBy
string
required

The user who last updated this organisation

I