Skip to main content

UserInvitationCreateResponse

Response for inviting a user to a network. Wraps the created UserInvitationDto with the public accept link the recipient was sent, and whether the invitation email actually went out (sending is best-effort --- a false here does not mean the invitation failed to create).

invitation object

The created invitation

idstring

Unique id of the invitation

Example: 7Hb2Kp9QvL3mNx0R8tZ4
networkIdstring

Id of the network the recipient is invited to join

Example: 9Kp3Lm2QvX7nRt0B8wZ5
emailstring

Email address the invitation was sent to

Example: member@example.com
firstNamestring

Recipient's first name

Example: Jordan
lastNamestring

Recipient's last name

Example: Lee
rolestring

Network membership role to grant on acceptance

Possible values: [admin, viewer]

Example: viewer
statusstring

Invitation lifecycle status

Possible values: [pending, accepted, expired, revoked]

Example: pending
expiresAtdate-time

When the invitation expires and can no longer be accepted

Example: 2026-01-15T09:30:00Z
createdAtdate-time

When the invitation was created

Example: 2026-01-15T09:30:00Z
updatedAtdate-time

When the invitation was last updated

Example: 2026-01-15T09:30:00Z
inviteUrlstring

Public link the recipient uses to accept the invitation

Example: https://app.adbridge.ai/invite/inv_3f9a2b7c1d8e4f60a5b2
emailSentboolean

Whether the invitation email was sent (best-effort; invitation is created regardless)

Example: true
UserInvitationCreateResponse
{
  "invitation": {
    "id": "7Hb2Kp9QvL3mNx0R8tZ4",
    "networkId": "9Kp3Lm2QvX7nRt0B8wZ5",
    "email": "member@example.com",
    "firstName": "Jordan",
    "lastName": "Lee",
    "role": "viewer",
    "status": "pending",
    "expiresAt": "2026-01-15T09:30:00Z",
    "createdAt": "2026-01-15T09:30:00Z",
    "updatedAt": "2026-01-15T09:30:00Z"
  },
  "inviteUrl": "https://app.adbridge.ai/invite/inv_3f9a2b7c1d8e4f60a5b2",
  "emailSent": true
}