provider Cancel Scheduled Sends GET /user/scheduled_sends/{batch_id}
@utdk/sendgrid /user/scheduled_sends/{batch_id}
Retrieve scheduled send
**This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**
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.

getUserScheduledSendsBatchId
GET/user/scheduled_sends/{batch_id}
**This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**

Parameters

required

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