POST/v1/workspace/processor/connections/{mailbox}/aliases

Add an alias to the workspace's intake mailbox

Adds an address to one of the workspace's processor accounts: a plus-address of it, an address Gmail already delivers to it, or with create: true a new alias made at Google through the workspace's domain-wide delegation, on a domain the workspace has verified. Google's refusal comes back in Google's words with what to do.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

mailboxpath · stringrequired

Request body

application/jsonrequired

bodyoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "addedAt": "string",
    "addedByEmail": "string",
    "address": "string",
    "createdAtGoogle": true,
    "id": "",
    "mailbox": "string",
    "purposes": [
      "string"
    ],
    "reason": "string",
    "source": "string",
    "tenantId": 1.5
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired