Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Body

application/json
kind
enum<string>
required
Available options:
discovery,
prepare,
follow-up
nextRunAt
string<date-time>
required
timezone
string
required
Maximum string length: 100
applicationId
string | null
Minimum string length: 1
query
string
default:""
Maximum string length: 500
interviewId
string | null
lead
enum<string> | null
Available options:
24h,
2h,
morning
enabled
boolean
default:true
email
boolean
default:false
intervalDays
integer | null
Required range: 1 <= x <= 30
aiProviderId
string | null
Minimum string length: 1
locale
string
Required string length: 2 - 20
id
string

Response

OK

id
string
required
userId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
applicationId
string | null
required
interviewId
string | null
required
kind
string
required
query
string
required
lead
string | null
required
locale
string
required
timezone
string
required
enabled
boolean
required
email
boolean
required
nextRunAt
string<date-time>
required
lastQueuedAt
string<date-time> | null
required
intervalDays
integer | null
required
Required range: -2147483648 <= x <= 2147483647
aiProviderId
string | null
required