v1

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB
Add x-hidden to endpoints

Update an organization

Update the detail of an organization.

patch/v3/organizations/{identifier}

Path parameters

identifierstring required

Uniquely identify an organization.

Example:mEFayXdO

Organization identifier.

Response

Successfully updated organization.

identifierstring required

Uniquely identify an organization.

namestring required
userRole'admin' | 'member' required
avatarstring nullable required

URL of the organization's avatar.

resthookSignatureKeystring nullable required

Used to sign webhook payloads so you can verify their integrity.

isTrialboolean required
showCustomFieldCreationboolean required

Whether to show the custom field creation in the UI.

allowDataSourceRecordCreationboolean required

Allow reviewers to create missing records from the data source selector. Keep disabled when data sources are managed by external system syncs.

Example response

{
  "identifier": "mEFayXdO",
  "name": "Grove Street King",
  "userRole": "admin",
  "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
  "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"
}