Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.

x-secret-key
string
header
required

Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.

Maximum string length: 255

Path Parameters

workflow_id
string
required
Pattern: ^WF_[A-Z]{2}_[A-Z0-9]{10,40}$

Body

application/json
external_id
string

Your own id (1 to 128 of A-Z a-z 0-9 . _ : -)

Pattern: ^[A-Za-z0-9._:-]{1,128}$
name
string

1–200 characters.

Required string length: 1 - 200
status
enum<string>

archived is reached only through DELETE

Available options:
active,
inactive,
draft
default_methods
enum<string>[]

Methods a mandate uses when it does not send its own

Required array length: 1 - 3 elements
Available options:
data_enrichment,
skill_verification,
interest_collection
delivery
object

Channels used to reach candidates

schedule
object

Send start_time and end_time together. Other keys merge; days is replaced as a whole list.

Response

The workflow after the change

success
boolean
message
string
data
object