Skip to main content
POST
Create Offer

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
application_id
string | null
start_date
string<date-time> | null

Date of creation

Example:

"2021-01-01T01:01:01.000Z"

offer_status
object | null
salary
number | null
currency
string | null
offer_history
object[] | null
passthrough
object | null

Value to pass through to the provider

Example:

Response

The offer was created successfully.

statusCode
number
required
Example:

201

message
string
required
Example:

"Record created successfully."

timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

data
object
required