Skip to main content
PUT
/
api
/
e2
/
email-addresses
/
{id}
JavaScript
import Inbound from 'inboundemail';

const client = new Inbound({
  apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted
});

const emailAddress = await client.emailAddresses.update('id');

console.log(emailAddress.id);
{
  "id": "<string>",
  "address": "<string>",
  "domainId": "<string>",
  "webhookId": "<string>",
  "endpointId": "<string>",
  "isActive": true,
  "isReceiptRuleConfigured": true,
  "receiptRuleName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "domain": {
    "id": "<string>",
    "name": "<string>",
    "status": "<string>"
  },
  "routing": {
    "type": "webhook",
    "id": "<string>",
    "name": "<string>",
    "isActive": true,
    "config": "<unknown>"
  },
  "warning": "<string>"
}

Authorizations

Authorization
string
header
required

Your Inbound API key. Include it in the Authorization header as: Bearer

Path Parameters

id
string
required

Body

endpointId
string · null · null
webhookId
string · null · null
isActive
boolean

Response

Response for status 200

id
string
required
address
string
required
domainId
string
required
webhookId
string · null · null
required
endpointId
string · null · null
required
isActive
boolean
required
isReceiptRuleConfigured
boolean
required
receiptRuleName
string · null · null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
userId
string
required
domain
object
required
routing
object
required
warning
string