Skip to content
API reference/Domain names

Add a business email address

Try it

box@domain forwards to an inbox they already use (Name.com email forwarding; included, up to 10 per domain). The same box again replaces where it goes.

POST/api/v1/domain-names/{registration_id}/email-forwards

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the domains:write scope — connect, check and remove domains.

domains:writeChanges the live siteIdempotency-Key requiredMCP tool: add_domain_email

Parameters

Named placeholders go in the path; the rest in a JSON body.

registration_idstringPath · required
The domain name's id.1 to 100 characters
boxstringBody · required
Before the @, e.g. hello1 to 64 characters
tostringBody · required
The inbox it arrives in.At most 200 characters

Response

201 with JSON on success (schema on the right). Errors use the standard envelope; a retry with the same Idempotency-Key gets the first answer back (how retries work).

curl
curl -X POST 'https://websites.workflowcorp.com/api/v1/domain-names/REGISTRATION_ID/email-forwards' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"box":"","to":""}'
Example arguments
{
  "registration_id": "REGISTRATION_ID",
  "box": "",
  "to": ""
}
Response schema
{
  "type": "object",
  "properties": {
    "email_forwards": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "box": {
            "type": "string"
          },
          "to": {
            "type": "string"
          }
        },
        "required": [
          "box",
          "to"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "email_forwards"
  ],
  "additionalProperties": false
}