Contacts API - Recipients
Elements that can be shared among more than one endpoint definition.
Update Recipient
PATCH /contactdb/recipients
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.
Authentication
- API Key
Headers
Request Body
The last name of the recipient. This is one of the default custom fields.
The first name of the recipient. This is one of the default custom fields.
[
{
"email": "jones@example.com",
"last_name": "Jones",
"first_name": "Guy"
}
]Responses
The number of errors found while adding recipients.
default: 0The indices of the recipient(s) sent that caused the error.
default: []The count of new recipients added to the contactdb.
default: 0The recipient IDs of the recipients that already existed from this request.
default: []The recipients who were updated from this request.
default: 0{
"error_count": 1,
"error_indices": [
2
],
"new_count": 2,
"persisted_recipients": [
"YUBh",
"bWlsbGVyQG1pbGxlci50ZXN0"
],
"updated_count": 0,
"errors": [
{
"message": "Invalid email.",
"error_indices": [
2
]
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}the error message
the field that generated the error
helper text or docs for troubleshooting
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.