Skip to main content
PATCH
/
email
/
senders
/
{sender_id}
Update Email Sender Identity
curl --request PATCH \
  --url https://api.getoutbox.ai/email/senders/{sender_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_name": "<string>",
  "from_email": "jsmith@example.com",
  "reply_to_email": "jsmith@example.com",
  "use_default_reply_to": true,
  "provider_sender_id": "<string>",
  "verification_details": "<unknown>",
  "is_default": true,
  "is_deleted": true,
  "verified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_email": "jsmith@example.com",
  "updated_at": "2023-11-07T05:31:56Z",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "from_name": "<string>",
  "reply_to_email": "jsmith@example.com",
  "use_default_reply_to": true,
  "provider_sender_id": "<string>",
  "verification_details": "<unknown>",
  "is_default": true,
  "is_deleted": true,
  "verified_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "connection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
sender_id
string<uuid>
required

Body

​
from_name
string
Maximum string length: 255
​
from_email
string<email>
Required string length: 1 - 255
​
verification_mode
enum<string>
  • single_email - Single Email
  • domain - Domain
Available options:
single_email,
domain
​
reply_to_email
string<email>
Maximum string length: 255
​
use_default_reply_to
boolean
​
status
enum<string>
  • pending - Pending
  • verified - Verified
  • failed - Failed
Available options:
pending,
verified,
failed
​
provider_sender_id
string
Maximum string length: 255
​
verification_details
any
​
is_default
boolean
​
is_deleted
boolean
​
verified_at
string<date-time> | null
​
created_at
string<date-time>
​
company
string<uuid>
​
connection
string<uuid> | null
​
domain
string<uuid> | null

Response

​
id
string<uuid>
required
read-only
​
from_email
string<email>
required
Maximum string length: 255
​
updated_at
string<date-time>
required
read-only
​
company
string<uuid>
required
​
from_name
string
Maximum string length: 255
​
verification_mode
enum<string>
  • single_email - Single Email
  • domain - Domain
Available options:
single_email,
domain
​
reply_to_email
string<email>
Maximum string length: 255
​
use_default_reply_to
boolean
​
status
enum<string>
  • pending - Pending
  • verified - Verified
  • failed - Failed
Available options:
pending,
verified,
failed
​
provider_sender_id
string
Maximum string length: 255
​
verification_details
any
​
is_default
boolean
​
is_deleted
boolean
​
verified_at
string<date-time> | null
​
created_at
string<date-time>
​
connection
string<uuid> | null
​
domain
string<uuid> | null