← Organization API

PUT/v1/organizations/{id}Update organization details

Change the details of an organization.
Only fields that are defined in the PUT method will be updated, all other fields will be be untouched. Setting a handshake can only by done by administrators, while setting a subscription can also by done by support
headerAuthorizationAuthentication token (bearer token or API key).
{
"name" : String,
"subscriptionId" : String
}

Response

status200All ok
status400Invalid input
status401Invalid authentication token
status403Insufficient rights
Number

Example: Update an organization as a user

PUT/v1/organizations/90

headerAuthorizationBearer e486a154-3cbe-46b8-87a1-0d46a15c54c8
{
"name": "Custom Name"
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 90
}

Example: Update an organization as a System Admin

PUT/v1/organizations/94

headerAuthorizationBearer 111d7a49-b4f7-43c8-8cbd-5b6a67f71066
{
"name": "Enterprise Org"
}

Response

status200
headerAccess-Control-Expose-Headersauthorization, content-type
headerAccess-Control-Allow-Headersauthorization, content-type
headerAccess-Control-Allow-MethodsGET, POST, DELETE, OPTIONS, PUT
headerAccess-Control-Allow-Origin*
headerStrict-Transport-Securitymax-age=31536000; includeSubDomains
headerX-Frame-OptionsSAMEORIGIN
headerX-Content-Type-Optionsnosniff
headerX-XSS-Protection1; mode=block
headerContent-Security-Policydefault-src 'none'; frame-ancestors 'none'; base-uri 'none'; form-action 'none'
headerReferrer-Policyno-referrer
headerFeature-Policyself
headerPermissions-policyinterest-cohort=()
{
"id": 94
}