Invite a member to the caller's tenant
Invite a member to the caller's tenant: CustomDomain™ API reference in the members group. Lists request parameters, the request body, responses and error codes.
Creates a pending member and its single-use invite link. The response carries invite_token; send the invitee a link built from it. The link works for 7 days, after which the member is reported as expired until an admin resends or revokes it. The inviter's email is taken from the credential that sends the invite, never from the body. Requires admin or owner (member:manage); a caller cannot invite a role above their own, and owner is reached only by promoting an existing member.
Authorization
apiKey Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/members" \ -H "Content-Type: application/json" \ -d '{ "email": "string" }'{ "id": "string", "tenant_id": "string", "email": "string", "role": "owner", "status": "active", "invited_by": "string", "inviter_email": "string", "inviter_name": "string", "invite_sent_at": "2019-08-24T14:15:22Z", "invite_expires_at": "2019-08-24T14:15:22Z", "invite_token": "string", "accepted_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}