Enable or disable email sending domain

Enables or disables sending from the verified domain. Can only be enabled once both DKIM and return-path are verified.

PATCH /api/v1/org/{organizationUuid}/email-whitelabel

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "createdAt": "2023-11-07T05:31:56Z",
    "lastCheckedAt": "2023-11-07T05:31:56Z",
    "dnsRecords": [
      {
        "verified": true,
        "value": "<string>",
        "name": "<string>"
      }
    ],
    "isEnabled": true,
    "isVerified": true,
    "returnPathVerified": true,
    "dkimVerified": true,
    "fromName": "<string>",
    "fromEmail": "<string>",
    "domain": "<string>",
    "organizationUuid": "<string>"
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Path Parameters

organizationUuid · string<uuid> · required

Stringified UUIDv4. See RFC 4112

Pattern: [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Body

application/json

Toggle sending on/off. Can only be enabled once fully verified.

isEnabled · boolean · required

Response

200

application/json

Ok

results · object | null · required

The full sender-identity configuration for an organization, as returned to the setup UI. null from the API means the org has not started setup.

Show child attributes

status · enum<string> · required

Available options: ok