Skip to main content
PUT
/
api
/
organizations
/
{organizationId}
/
document-types
Update organization document types
curl --request PUT \
  --url https://your-instance.example.com/api/organizations/{organizationId}/document-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documentTypes": [
    {
      "name": "Credit Bureau",
      "isRequired": true
    },
    {
      "name": "Paystub",
      "isRequired": true
    }
  ]
}
'
{
  "success": true,
  "documentTypes": [
    {
      "name": "Credit Bureau",
      "isRequired": true
    },
    {
      "name": "Paystub",
      "isRequired": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organizationId
string
required

Body

application/json
​
documentTypes
object[]
required

Full replacement list of document types the organization collects from contacts; each entry carries a name, required flag, and optional description.

Response

Document types updated

​
success
enum<boolean>
Available options:
true
​
documentTypes
object[]