API Reference

Update Workflow

put
https://api-sandbox.urbanpayx.com/api/v1/contracts/workflows/

Update signing workflow

Updates the configuration of a DRAFT signing workflow. Only workflows in DRAFT status can be modified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
length between 1 and 255
length ≤ 255
string
required
variables
object
participants
array of objects
required
length ≥ 1
Participants*
string
required
length between 1 and 64

Unique key identifying this participant within the workflow

string
enum
required

Source that determines who fills this participant role (e.g. client or end user)

Allowed:
string
required
length between 1 and 255

Signer role name as defined in the contract template

field_values
object

Pre-filled field values for this participant

readonly_fields
array of strings

Field names that this participant cannot modify

Readonly Fields
stages
array of objects
required
length ≥ 1
Stages*
integer
required
≥ 1

Sequential stage number, starting from 1

string
enum
required

Stage type — either a signature step or a wait-for-transaction step

Allowed:
length ≤ 64

Participant key assigned to this stage; required for signature stages

SignatureDeliveryType | null

How the signing request is delivered to the participant; required for signature stages

email_notifications
object

Per-event email notification toggles for this workflow

Responses

Updated 17 days ago

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

Updated 17 days ago