provider Cancel Scheduled Sends PATCH /user/scheduled_sends/{batch_id}
@utdk/sendgrid /user/scheduled_sends/{batch_id}
Update a scheduled send
**This endpoint allows you to update the status of a scheduled send for the given `batch_id`.** If you have already set a `cancel` or `pause` status on a scheduled send using the "Cancel or pause a scheduled send" endpoint, you can update it's status using this endpoint. Attempting to update a status once it has been set with the "Cancel or pause a scheduled send" endpoint will result in a `400` error.
batch_id path required
string
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.

patchUserScheduledSendsBatchId
PATCH/user/scheduled_sends/{batch_id}
**This endpoint allows you to update the status of a scheduled send for the given `batch_id`.** If you have already set a `cancel` or `pause` status on a scheduled send using the "Cancel or pause a scheduled send" endpoint, you can update it's status using this endpoint. Attempting to update a status once it has been set with the "Cancel or pause a scheduled send" endpoint will result in a `400` error.

Parameters

required

Input

required

The status you would like the scheduled send to have.

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.patchUserScheduledSendsBatchId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})