Menu

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 /verified_senders/{id}

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

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
nickname
string
maxLength: 100
required
from_email
string
format: emailmaxLength: 256
required
from_name
string
maxLength: 256
reply_to
string
format: emailmaxLength: 256
required
reply_to_name
string
maxLength: 256
address
string
maxLength: 100
address2
string
maxLength: 100
state
string
maxLength: 2
city
string
maxLength: 150
zip
string
maxLength: 10
country
string
maxLength: 100
{
  "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

id
string
default: None
required

Responses

object
id
integer
nickname
string
from_email
string
from_name
string
reply_to
string
reply_to_name
string
address
string
address2
string
state
string
city
string
zip
string
country
string
verified
boolean
locked
boolean
{
  "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
}
object
errors
array[object]
required
field
string
message
string
error_id
string
object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
required
message
string
error_id
string
object
errors
array[object]
required
message
string
error_id
string
object
errors
array[object]
message
string
Rate this page:

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.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more