provider Contacts API - Lists POST /contactdb/lists/{list_id}/recipients
@utdk/sendgrid /contactdb/lists/{list_id}/recipients
Add Multiple Recipients to a List
**This endpoint allows you to add multiple recipients to a list.** Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs should be passed exactly as they are returned from recipient endpoints.
list_id path required
The id of the list of recipients you want to retrieve.
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.

postContactdbListsListIdRecipients
POST/contactdb/lists/{list_id}/recipients
**This endpoint allows you to add multiple recipients to a list.** Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs should be passed exactly as they are returned from recipient endpoints.

Parameters

required

The id of the list of recipients you want to retrieve.

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