Skip to main content
POST
Roll a leads qualification configuration form token

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Path Parameters

id
string
required

The id identifier.

Response

200 - application/json

Returns the qualification configuration with the new form token.

id
string
required

Unique identifier for the object.

created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

object
enum<string>
required
Available options:
leads.qualification_configuration
active
boolean
required

Whether the qualification configuration is active.

after_completion
object
required

Configuration for after the qualification is completed.

default
boolean
required

Whether this is the default qualification configuration.

description
string | null
required

An arbitrary description attached to the object.

hosted_qualification_url
string<uri> | null
required

The URL for the hosted qualification form.

name
string
required

The name of the qualification configuration.

token
string | null
required

The hosted form token (qct_…). Pass this to Yorlet.js to embed the form on your website.

allowed_origins
string[]
required

Website origins allowed to embed this form. An empty list allows the form to be embedded on any website.

questions
object
required

Set of standard qualification questions to ask leads.

custom_questions
object[]
required

Custom freeform questions to ask leads.

account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

deleted
boolean
default:false

Only returned if the object has been deleted.

metadata
object | null

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.