Skip to content

Create an inbound-email alias

POST
/v1/aliases

Define an inbound-email address. The address is computed + validated SERVER-SIDE from kind, localPart and (for custom) domainId: a platform alias's .<org-slug>@<platform-domain> suffix is fixed and server-supplied; a custom alias is <localPart>@<host> (or *@<host>) on the org's verified email domain. A malformed/forbidden address returns 400; a duplicate address on the org returns 409.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"kind": "platform",
  
"domainId": "dom_01JX9",
  
"localPart": "orders",
  
"destinationIds": [
  
  
"string"
  
],
  
"allowedSenders": [
  
  
"string"
  
],
  
"maxSizeBytes": 26214400
}

Responses

Created.

application/json
JSON
{
  
"id": "al_01JX9",
  
"address": "orders.acme@emhk.in",
  
"kind": "platform",
  
"localPart": "orders",
  
"domain": "emhk.in",
  
"destinationIds": [
  
  
"string"
  
],
  
"allowedSenders": [
  
  
"string"
  
],
  
"maxSizeBytes": 26214400,
  
"createdAt": "string"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product