Create a document type (Beta)

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

Creates a document type in the caller's organization. The name is required; everything else is optional. externalId must be unique per organization. validationSettings is a JSON-encoded string whose only recognised keys today are validFor and issuedAfter (each { "value": number, "unit": "DAYS"|"MONTHS"|"YEARS" }).

Once created, reference the returned id from a Campaign DOCUMENT question via documentItems: [{ documentTypeId }]. The server populates a readable documentTypeName copy on each reference so the Campaign payload is greppable without a join. See POST /v1/campaigns for the per-question shape.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Document type payload

string
required

Human-readable name shown to recruiters and candidates.

validation
array of strings

Validation checks to apply to documents of this type.

validation
Allowed:
classificationRules
array of objects

Rules used to recognise documents of this type.

classificationRules
string

JSON-encoded settings that tune the validation checks. Example: {"validFor":{"value":6,"unit":"MONTHS"}}.

string

Stable customer-controlled identifier. Must be unique per organization. Allowed characters: [A-Za-z0-9._-]+

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json