latestOpenAPI 3.0.12026-08-201361,071786.8 KB

8e8601db4e66

ApplicantWorkflowApiAgentResource

Create or update a draft workflow

Creates a new draft workflow or updates an existing one. Omit id to create a new draft: the server assigns the id, revision number, and a draft status. Provide an existing id to update that draft in place. Only drafts can be edited — a published or archived revision is read-only, so to change a published workflow create a new draft revision from it first. The response includes a notices list describing any schema or logic problems; saving does not require the workflow to be free of notices, so you can store a work-in-progress draft and resolve them before publishing.

Node and edge ids are stable handles. You choose each node's id; an edge id is optional on input and is assigned by the server when omitted. Both are returned in the response. When you edit a workflow, resend the ids you received rather than dropping them — an edge that arrives without an id is saved as a new transition with a new id, and runs recorded on the previous revision then point at edges the new revision no longer has, which makes those runs ineligible for upgrade. The safe loop is: read the workflow, change only what you need in the document you got back, and post that document.

Workflow names:

  • default — runs for any verification via standard applicant levels. Selected automatically.
  • actions — runs for any applicant action. Selected automatically.
  • test — an isolated counterpart of default for testing workflow changes. The system never selects it automatically; start it manually on an applicant.
post/resources/api/agent/applicantWorkflows

Request body

idstring
name'default' | 'test' | 'actions'

Workflow name shared by every revision of the same workflow.

revisioninteger

Revision number. Assigned by the server; leave unset.

revisionStatusstring

Managed by the server: new workflows start as a draft, and status changes go through the publish or archive endpoint.

titlestring

Display title of the workflow.

Response

default response

clientIdstring

Identifier of the client that owns this workflow.

idstring
namestring

Workflow name shared by every revision of the same workflow.

revisioninteger

Revision number within the workflow; increases with each new revision.

revisionStatusstring

Current status of this revision.

titlestring

Display title of the workflow.