Sign in

v1

latestOpenAPI 3.0.02026-07-17166300328.1 KB
Organisations

Edit organisation

put/admin/organisations/edit/{organisationId}

Path parameters

string required
OR
string uuid required
Example:12345

UUID or numeric ID of the organisation

Request body

namestring
typestring nullable
nationalitystring nullable
sectorstring nullable
contactsstring nullable
descriptionstring nullable
localboolean nullable
uuidstring uuid nullable
restricted_to_domainstring[] nullable

Example request

{
  "name": "ORGNAME",
  "type": "ADMIN"
}

Response

Organisation list response

idstring
namestring
date_createdstring
date_modifiedstring
descriptionstring
typestring nullable
nationalitystring
sectorstring
created_bystring
uuidstring
contactsstring nullable
localboolean
restricted_to_domainstring[]
landingpagestring nullable
user_countstring nullable
created_by_emailstring nullable

Example response

{
  "id": "12345",
  "name": "ORGNAME",
  "date_created": "2021-06-14 14:29:19",
  "date_modified": "2021-06-14 14:29:19",
  "type": "ADMIN",
  "created_by": "12345",
  "user_count": "3"
}