Skip to main content
← All schemas

InvitationCreated

object

invitationrequired
Invitation
urlrequired
string

The invite link — shown once (only its hash is stored); valid 7 days.

sharerequired
object
share.messagerequired
string
share.whatsapp_urlrequired
string or null

wa.me link with the message, for phone invites.

share.email_urlrequired
string or null

mailto: link with the message, for email invites.

Example
{
  "invitation": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "email": "string",
    "phone": "string",
    "role": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "branch": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "reports_to": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "invited_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "expires_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "expired": true
  },
  "url": "string",
  "share": {
    "message": "string",
    "whatsapp_url": "string",
    "email_url": "string"
  }
}