Update a document type (Beta)

patch

https://api.joinpopp.com/v1/document-types/{documentTypeId}

Beta: this endpoint is still in active development; payload shape and validation rules may change.

Partially updates a document type. Pass only the fields you want to change. To clear a nullable field send an explicit null.

Constraints:

Cannot update an archived document type (returns 409). Restore is not supported — create a new one.
The name cannot be changed while the document type is referenced by a campaign or workflow (returns 409). Other fields can still be edited.
externalId must be unique per organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

documentTypeId

string

required

The ID of the document type

Body Params

Fields to update

name

string

Human-readable name. Cannot be changed once the document type is referenced by a campaign or workflow.

validation

array of strings

Validation checks to apply to documents of this type. Pass null to clear.

validation

Allowed:

classificationRules

array of objects

Rules used to recognise documents of this type. Pass null to clear.

classificationRules

validationSettings

string

JSON-encoded settings that tune the validation checks. Pass null to clear.

externalId

string

Stable customer-controlled identifier. Must be unique per organization. Pass null to clear.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200