Skip to main content
POST

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml
x-api-language
enum<string>[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Available options:
all,
ar_AR,
bg_BG,
bn_IN,
ca_ES,
cs_CZ,
cy_GB,
da_DK,
de_DE,
en_GB,
en_US,
el_GR,
es_NN,
es_LA,
et_EE,
fa_NN,
fi_FI,
fr_FR,
fr_CA,
he_IL,
hi_IN,
hr_HR,
hu_HU,
hy_AM,
it_IT,
ja_JP,
ko_KR,
lt_LT,
ms_MY,
nl_NL,
nb_NO,
pl_PL,
pt_BR,
ro_RO,
ru_RU,
sk_SK,
sl_SI,
sq_AL,
sr_RS,
sv_SE,
sw_NN,
th_TH,
tr_TR,
uk_UA,
vi_VN,
zh_CN,
zh_HK

Body

application/json

Organisation creation payload.

name
string
required

Name of the organisation.

Maximum string length: 255
administrator
string

Slug of the user who administers the organisation.

Pattern: ^[A-Za-z]{8}$
authorised_domains
string<hostname>[]

Email domains used to associate new users with the organisation, such as example.com.

organisation_fields
object

Values of the custom fields related to organisations, keyed by field slug. For example, { "fJkIjGmB": "Test value" }. Single-value fields take a string; multi-value fields, such as checkbox or multi-select, take an array of strings.

Response

Organisation created.

Single organisation, including the administrator, authorised domains, and custom field values.

administrator
object | null

User who administers the organisation, or null when the organisation has no administrator.

created
string<date-time>

Date and time when the organisation was created.

id
string

ID of the organisation.

member_count
integer

Number of members in the organisation.

Required range: x >= 0
name
string

Name of the organisation.

updated
string<date-time>

Date and time when the organisation was last updated.

authorised_domains
object[]

Email domains used to associate new users with the organisation.

organisation_fields
object[]

Values of the custom fields related to organisations.