/domains/{id}/aliases (POST)
POST
/domains/{id}/aliases
const url = 'https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/aliases';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"localPart":"example","destinations":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/aliases \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "localPart": "example", "destinations": [ "example" ] }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
localPart
required
string
destinations
required
Array<string>
Examplegenerated
{ "localPart": "example", "destinations": [ "example" ]}Responses
Section titled “Responses”Default Response
Media typeapplication/json
object
id
required
string format: uuid
domainId
required
string format: uuid
address
required
string
destinations
required
Array<string>
active
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Examplegenerated
{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "domainId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "address": "example", "destinations": [ "example" ], "active": true, "createdAt": "2026-04-15T12:00:00Z", "updatedAt": "2026-04-15T12:00:00Z"}