Skip to main content
POST
Create a qualification route

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
name
string
required

The name of the qualification route.

Minimum string length: 1
qualification_configuration
string
required

The ID of the qualification configuration to attach when this route matches.

active
boolean

Whether the route is evaluated against new enquiries.

conditions
object

Match conditions for this route. Unset or empty lists match any value.

description
string | null

An arbitrary description attached to the object.

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.

notification
object

Notification preferences applied when this route matches a new enquiry.

priority
integer

Evaluation order. Lower values are matched first. Defaults to 100.

Response

200 - application/json

Returns the qualification route object if the request succeeded.

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_route
active
boolean
required

Whether the route is evaluated against new enquiries.

conditions
object
required

Match conditions for this route. Unset or empty lists match any value.

description
string | null
required

An arbitrary description attached to the object.

name
string
required

The name of the qualification route.

notification
object
required

Notification preferences applied when this route matches a new enquiry.

priority
integer
required

Evaluation order. Lower values are matched first.

qualification_configuration
required

The qualification configuration attached when this route matches.

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.