Add Custom scheduled report recipient

post

https://api.scalepad.com/lifecycle-manager/v1/scheduled-reports/custom/{scheduled_report_id}/recipients

Add a recipient to a custom scheduled report. The recipient is stored on the report as a name and email and is not added to the client contact list.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

scheduled_report_id

string

required

The custom scheduled report to add a recipient to.

Body Params

Request payload for Add Custom scheduled report recipient.

full_name

string | null

Optional name the recipient is addressed by in the email. Omit it to address them by their
email address alone. A first name, or a first and last name; anything longer is rejected. When
supplied and the address has no existing contact, it is also stored as the first name of the
backing contact record described under email_address.

email_address

string

required

Email address the report is sent to. When the client already has a contact with this address the
recipient is linked to it. Otherwise a contact record is created for the address in a deleted state,
so it backs the recipient without appearing in the client's contact list.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

201

Created

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Bad Request

402Payment Required

403Forbidden

404Not Found