Skip to main content
PUT
Edit Organisation

Path Parameters

organisation
integer
required

The organisation ID

Body

application/json
name
string
description
string | null
short_description
string | null
icon
string | null
image_url
string | null
notes
string | null
type
enum<string>
Available options:
company,
stockist,
brand,
organisation,
group,
school,
club,
other
status
string | null
is_tenant
boolean | null
is_active
boolean | null
phone
string | null
email
string<email> | null
secondary_phone
string | null
domain
string | null
authorised_domains
string | null
meta
string[] | null
address
object
locations
integer[] | null
custom_fields
object[]

Response

Organisation

data
Organisation · object
required