provider Contacts API - Lists POST /contactdb/lists/{list_id}/recipients/{recipient_id}
@utdk/sendgrid /contactdb/lists/{list_id}/recipients/{recipient_id}
Add a Single Recipient to a List
**This endpoint allows you to add a single recipient to a list.**
list_id path required
The ID of the list that you want to add the recipient to.
integer
recipient_id path required
The ID of the recipient you are adding to the list.
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.

postContactdbListsListIdRecipientsRecipientId
POST/contactdb/lists/{list_id}/recipients/{recipient_id}
**This endpoint allows you to add a single recipient to a list.**

Parameters

required

The ID of the list that you want to add the recipient to.

required

The ID of the recipient you are adding to the list.

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