provider Campaigns API POST /campaigns/{campaign_id}/schedules
@utdk/sendgrid /campaigns/{campaign_id}/schedules
Schedule a Campaign
**This endpoint allows you to schedule a specific date and time for your campaign to be sent.** If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won't be going through our servers at the same times as everyone else's mail.
campaign_id path required
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

postCampaignsCampaignIdSchedules
POST/campaigns/{campaign_id}/schedules
**This endpoint allows you to schedule a specific date and time for your campaign to be sent.** If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won't be going through our servers at the same times as everyone else's mail.

Parameters

required

Input

required

The unix timestamp for the date and time you would like your campaign to be sent out.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.postCampaignsCampaignIdSchedules({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})