Tearleads

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

NameInTypeDetails
organizationIdpathstringrequired
  • lowercase UUID v4

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
  • organizationIdstringrequired
  • profileDocumentIdstringrequirednullable

Other fields are allowed.

Other responses

StatusMeaningBody
400Bad Request

application/jsonErrorResponse

401Unauthorized

application/jsonSessionFailureResponse

402Payment Required

application/jsonPaymentRequiredErrorResponse

403Forbidden

application/jsonErrorResponse

404Not Found

application/jsonErrorResponse

500Internal Server Error

application/jsonErrorResponse

503Service Unavailable

application/jsonErrorResponse