Create workspace email identity

POST

/workspace-email-identities

WorkspaceEmailIdentities

Provisions a branded SES sending identity for the workspace's own domain: creates the SES domain identity (Easy DKIM), configures the custom MAIL FROM sub-domain, associates the identity with the workspace's SES tenant, and returns the DNS records the customer must publish. Once the identity verifies, workspace emails are sent from this domain.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Workspace email identity created successfully

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/workspace-email-identities' \
--header 'x-idempotency-key;' \
--header 'Content-Type: application/json' \
--data '{
    "domain": "project.company.com"
}'

Response Example

{
    "workspaceEmailIdentityId": "FUMzPf00hz_kcj2R2Hlzq",
    "domain": "project.company.com",
    "status": "PENDING",
    "dkimTokens": [
        "string"
    ],
    "dkimStatus": "SUCCESS",
    "mailFromStatus": "SUCCESS",
    "sesRegion": "us-east-1",
    "verifiedAt": "2019-08-24T14:15:22.123Z",
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "dnsRecords": [
        {
            "kind": "DKIM",
            "type": "CNAME",
            "name": "token1._domainkey.thinkfinancialwellbeing.hsbc.com",
            "value": "token1.dkim.amazonses.com"
        }
    ]
}

Modified at 2026-07-22 08:08:42

List workspace email identities

Get workspace email identity