provider Contacts API - Recipients PATCH
/contactdb/recipients @utdk/sendgrid
/contactdb/recipients Update Recipient
**This endpoint allows you to update one or more recipients.**
The body of an API call to this endpoint must include an array of one or more recipient objects.
It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the default custom fields SendGrid provides.
- 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.
Code snippet
Updates live as you fill in the form above.
TypeScript
import sendgrid from '@utdk/sendgrid';
await sendgrid.patchContactdbRecipients({
"on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})