Publish signing workflow
Publishes a DRAFT signing workflow, making it available for use in contract requests.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Publishes a DRAFT signing workflow, making it available for use in new contract requests. The endpoint validates the workflow definition against its template, snapshots the validated definition, sets the workflow status to published, stamps published_at, and returns the updated workflow.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - The caller must hold the
contracts.workflows.publishpermission and have the OWNER or OPERATIONS role. - Contract signing must be enabled for the client. If the feature is disabled the request returns
403.
Path parameters
workflow_id(string, required) — ID of the signing workflow to publish. It must belong to your client.
Preconditions
Before a workflow can be published:
- The workflow must not be archived. Archived workflows cannot be published (
400); restore them to draft first. - The workflow's contract template version must already be published. Publishing a workflow whose template is still in draft returns
400. - The workflow definition is re-validated at publish time. It must define at least one participant and at least one stage, and must satisfy these rules (any violation returns
400):- Each participant must have a unique key and a role that exists on the template, and each template role may be used by only one participant.
- Each participant source must be one of the supported sources.
- Stage indexes must be sequential starting from 1, and each stage must be a supported type.
- A signature stage must reference a known participant, use a supported delivery type, and a participant may not appear in more than one signature stage.
- Autosign delivery is only allowed for a participant that signs on behalf of the client, and a client signing profile must exist before such a workflow can be published.
- At most one wait-for-payment stage is allowed.
Response
200 OK returns the updated SigningWorkflowResponse, including its id, name, template_version_id, status (now published), participants, stages, variables, email_notifications, and published_at.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | Workflow not found under this client, or its template version not found |
400 | Workflow is archived; template is not yet published; or the workflow definition fails validation (no participants/stages, invalid participant key/role/source, non-sequential or unsupported stages, invalid signature delivery, missing client signing profile for autosign, or more than one wait-for-payment stage) |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.