ApplicantWorkflowApiAgentResource

Create a new draft revision from an existing one

Changed on

Creates a new editable draft by copying the title, nodes, and edges of an existing revision. The new draft keeps the same workflow name with the next revision number, letting you iterate on a published workflow without altering the live version. The source revision must not itself be a draft, and a workflow can have only one draft at a time. Optionally supply a name in the body to copy the definition under a different workflow name; in that case an existing draft with that name is updated rather than rejected.

post/resources/api/agent/applicantWorkflows/{id}/draft

Request

  • Base URL: https://api.sumsub.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.sumsub.com/resources/api/agent/applicantWorkflows/{id}/draft
  • Auth: none declared

Path parameters

idstring required

Id of the source workflow revision to copy.

Request body

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

Workflow name to copy the source revision under. Omit to keep the source workflow's name.

Example request

{
  "name": "default"
}

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.

Changes

  • 633f4140e788Revision changes
    • warning

      added the new SUSPICIOUS_DOCUMENT enum value to the //// response property for the response status

  • 6ea8bfe33698Revision changes
    • warning

      added the new HIGH_RISK enum value to the //// response property for the response status

    • 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

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property // to the response with the status