Skip to main content
POST
Create Schedule
Use this endpoint to queue a message for future delivery.
Check the OpenAPI operation description for timing constraints such as lead time and interval alignment.

Authorizations

Authorization
string
header
required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

Send the signed JWT as a bearer token:

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Body

application/json

Schedule json

_
integer
content
object
conversation_id
integer
execute_at
string
inbox_id
integer
is_email
boolean
list_id
integer
local_id
string
phone_number
string
super_id
integer
targets
string[]
user_id
integer

Response

OK

id
integer
rev
integer
uuid
string