PUT/organizations/{organizationId}/profile
Update the organization profile
Operation organizations.profile.update
Description
Binds, or clears, the organization's encrypted profile document, which holds profile fields such as its name that the server cannot read. Only organization administrators may call it.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Parameters
| Name | In | Type | Details |
|---|---|---|---|
organizationId | path | string | required
|
Request body
application/jsonUpdateOrganizationProfileRequest
Binds or clears the organization's encrypted profile document.
1 field
profileDocumentIdstringrequirednullable- lowercase UUID v4
Other fields are allowed.
Responses
200 OK
application/jsonOrganizationProfileResponse
The organization's encrypted profile document binding.
2 fields
organizationIdstringrequiredprofileDocumentIdstringrequirednullable
Other fields are allowed.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 402 | Payment Required |
|
| 403 | Forbidden |
|
| 404 | Not Found |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|