Skip to main content
POST
/
organisations
Create a new organisation
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/organisations \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "language": "<string>",
  "timezone": "<string>",
  "slug": "<string>",
  "emails": [
    "jsmith@example.com"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "language": "<string>",
  "timezone": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Body

application/json

The input required to create an 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
​
slug
string
required

The slug of the organisation

​
emails
string<email>[]
required

Array of email addresses that should have access to the organisation

Minimum array length: 1

Response

Successful response

​
id
string
required

The id of the organisation

Pattern: ^[0-9a-fA-F]{24}$
​
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