Create Schedule

post

https://api.scalepad.com/lifecycle-manager/v1/deliverables/templates/{template_id}/schedules

Create a schedule that produces and emails a deliverable from a template on a recurring or one-time cadence.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

template_id

string

required

The deliverable template the schedule produces deliverables from.

Body Params

Request body for creating a deliverable schedule.

client_id

string

required

The client each fire produces a deliverable for.

cadence

object

required

When the schedule fires.

send_to_key_contacts

boolean

required

When true, the client's key contacts are added to the recipient list at each fire,
in addition to any explicit recipients.

recipients

array of objects

required

Explicit recipients to send to. Each must provide exactly one of contact_id or email.

recipients*

email_subject

string

required

Templated email subject. May contain {{...}} variable markers.

email_body

string

required

Templated email body. Include {{share_link}} to deliver a link, or enable attach_pdf.

attach_pdf

boolean

required

When true, the worker attaches a generated PDF of the deliverable to each send.

activate_on_save

boolean

required

When true, the schedule starts active and its first occurrence is scheduled immediately;
otherwise it is saved paused. A schedule with no future occurrence is always saved paused.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

201Created

400Bad Request

402Payment Required

403Forbidden

404Not Found