Skip to main content
POST
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

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

Body

application/json
name
string
required

Campaign name, 1–200 characters.

Required string length: 1 - 200
candidates
object[]
required

Required. 1 to 1,000 of { name, phone_number, external_id? }. phone_number is an Indian mobile: 10 digits, or with +91. A row with an invalid number, a number that opted out, or a number already earlier in the list is skipped and returned in skipped; it never fails the call. external_id comes back on every candidate and result.

Required array length: 1 - 1000 elements
language
enum<string>

Invite language; defaults to the enrichment's schedule language

Available options:
english,
tamil,
hindi,
kannada,
telugu,
malayalam,
bengali,
marathi

Response

The new campaign, its candidates and the rows skipped

success
boolean
message
string
data
object