Skip to main content
PATCH
/
api
/
e2
/
domains
/
{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 domain = await client.domains.update('id', { isCatchAllEnabled: true });

console.log(domain.id);
{
  "id": "<string>",
  "domain": "<string>",
  "status": "<string>",
  "isCatchAllEnabled": true,
  "catchAllEndpointId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "catchAllEndpoint": {
    "id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "isActive": true
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

isCatchAllEnabled
boolean
required
catchAllEndpointId
string · null · null

Response

Response for status 200

id
string
required
domain
string
required
status
string
required
isCatchAllEnabled
boolean
required
catchAllEndpointId
string · null · null
required
updatedAt
string<date-time>
required
catchAllEndpoint
object