Organizations

Create pending membership domain verification

Adds a domain + verification email for open membership. Domain stays pending until a verification code is sent and confirmed.

post/v2/organization/{organization}/membership-domains

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/organization/{organization}/membership-domains
  • Auth: HTTP bearer

Path parameters

organizationstring required

Organization unique name (URL-safe slug)

Example:zephyr-cloud

Request body

domainstring required

Domain to verify ownership for (accepts company.com or @company.com)

verificationEmailstring email required

Email address that belongs to the domain (must end with @domain)

role'viewer' | 'editor'

Role assigned to auto-joined members for this domain

Example request

{
  "domain": "company.com",
  "verificationEmail": "it-admin@company.com",
  "role": "viewer"
}

Response

Membership domain verification challenge

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440123",
    "domain": "example.com",
    "emailDomain": "@example.com",
    "status": "pending",
    "verificationEmail": "it-admin@example.com",
    "role": "viewer",
    "codeExpiresAt": "2026-03-02T13:10:00.000Z",
    "lastSentAt": "2026-03-02T12:55:00.000Z",
    "sendCount": 2,
    "attemptCount": 1,
    "verifiedAt": "2026-03-02T13:00:00.000Z",
    "createdAt": "2026-03-02T12:55:00.000Z",
    "updatedAt": "2026-03-02T13:10:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.