Sender Verification
The Sender Verification API exposes multiple endpoints that allow you to programmatically manage the Sender Identities that are authorized to send email for your account. You can also manage Sender Identities in the SendGrid app by selecting Sender Authentication under Settings in the navigation bar. For full app instructions, see Sender Verification.
The Sender Verification API provides a RESTful interface for creating new Sender Identities, retrieving a list of existing Sender Identities, checking the status of a Sender Identity, updating a Sender Identity, and deleting a Sender Identity.
This API offers additional endpoints to check for domains known to implement DMARC, and resend verification emails to Sender Identities that have yet to complete the verification process.
Edit Verified Sender
PATCH /v3/verified_senders/{id}
Base url: https://api.sendgrid.com
This endpoint allows you to update an existing Sender Identity.
Pass the id
assigned to a Sender Identity to this endpoint as a path parameter. Include any fields you wish to update in the request body in JSON format.
You can retrieve the IDs associated with Sender Identities by passing a GET
request to the Get All Verified Senders endpoint, /verified_senders
.
Note: Unlike a PUT
request, PATCH
allows you to update only the fields you wish to edit. Fields that are not passed as part of a request will remain unaltered.
Authentication
- API Key
Headers
Request Body
{
"nickname": "Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105"
}
Path Parameters
Responses
{
"id": 1234,
"nickname": "Example Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St.",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105",
"verified": true,
"locked": false
}
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. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.