AFaffinda
Add x-hidden to endpoints

Update an organization

Changed on

Update the detail of an organization.

patch/v3/organizations/{identifier}

Request

Path parameters

identifierstring required

Uniquely identify an organization.

Example:mEFayXdO

Organization identifier.

Request body multipart/form-data

namestring
avatarstring binary

Upload avatar for the organization.

resthookSignatureKeystring nullable

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

Example request

{
  "name": "Grove Street King",
  "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"
}

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"
}

Changes

  • acca5642c0bcRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

  • 978cf99a2ac0Revision changes
    • info

      api tag Add x-hidden to endpoints added

    • info

      api tag Organization API - Organization removed

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status