AM
JA
無料で始める
メニュー
API

Email Identities

Approved sender identities for outbound email

api email-identities

Contents

Approved sender identities for outbound email

GET/api/accounts/{account_id}/email-identities

List email identities for an account. Email identities represent approved sender addresses used for outbound mail.

Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
idstringrequired
Unique identifier for an email identity.
account_idstringrequired
Unique identifier for an account.
namestring | nullrequired
linksobjectrequired
selfstringrequired
URL of the current page
nextstring
URL of the next page
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/{account_id}/email-identities

Create an email identity for an account. Email identities allow sending mail from approved addresses.

Body application/json
namestring | null
Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Unique identifier for an email identity.
account_idstringrequired
Unique identifier for an account.
namestring | nullrequired
linksobjectrequired
selfstringrequired
URL of the created resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
POST/api/accounts/{account_id}/email-identities/search

Search email identities using Lucene-style query syntax.

Supported fields:

  • id: - Search email identity id
  • email: - Search email address
  • name: - Search display name

Operators:

  • AND - Both conditions must match
  • OR - Either condition must match
  • * - Wildcard (e.g., email:*@example.com)

Examples:

  • email:billing@
  • name:Operations
  • email:*@example.com AND name:ops
Body application/json
querystringrequired
Lucene-style search query. Supports field:value syntax (id:, email:, name:), wildcards (*), and boolean operators (AND, OR). Example: 'email:*@example.com AND name:ops'
limitinteger
Maximum number of results to return (default: 20, max: 100)
offsetinteger
Number of results to skip for pagination
sort
Responses
200application/json
OK
schemaobject
dataarrayrequired
itemobjectrequired
idstringrequired
Unique identifier for an email identity.
account_idstringrequired
Unique identifier for an account.
namestring | nullrequired
metaobjectrequired
querystringrequired
totalnumberrequired
limitnumberrequired
offsetnumberrequired
sortrequired
linksobjectrequired
selfstringrequired
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
DELETE/api/email-identities/{email_identity_id}

Delete an email identity.

Responses
204
Deleted
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
404application/problem+jsonProblemDetails
Not Found
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
GET/api/email-identities/{email_identity_id}

Get an email identity by its email identity ID.

Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Unique identifier for an email identity.
account_idstringrequired
Unique identifier for an account.
namestring | nullrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
PATCH/api/email-identities/{email_identity_id}

Update email identity metadata using JSON Merge Patch (RFC 7396). Use this to rename or clear the display name for an email identity.

Body application/json
namestring | null
Responses
200application/json
OK
schemaobject
dataobjectrequired
idstringrequired
Unique identifier for an email identity.
account_idstringrequired
Unique identifier for an account.
namestring | nullrequired
linksobjectrequired
selfstringrequired
URL of the current resource
400application/problem+jsonValidationProblemDetails
Bad Request
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring
defaultapplication/problem+jsonProblemDetails
HTTP Error
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring

Models

EmailAddress
string · email
A valid, normalized email address.
ProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
ValidationProblemDetails
typestring · urirequired
titlestringrequired
statusintegerrequired
detailstring
instancestring · uri
codestring
invalid_paramsarray
itemobjectrequired
instring
pathstring
typestring
expectedstring
receivedstring