Invitations

Create an invitation

Changed on

Invites a new member by email and sends the invitation email. The response includes the accept token and acceptUrl (returned only on create and renew).

post/invitations

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/invitations
  • Auth: HTTP bearer

Request body

emailstring email required

The email address to invite.

role'admin' | 'member' required

The role the invitee receives on accept.

Response

The invitation was created.

idstring required

Unique identifier for the invitation.

object'invitation' required

String representing the object's type.

emailstring required

The invited email address.

rolestring required

The role the invitee will receive on accept.

statusstring required

The invitation status: pending, expired, accepted, declined.

expiresAtstring required

ISO-8601 timestamp of when the invitation expires.

invitedByUserIdstring nullable required

Identifier of the user who created the invitation.

createdAtstring required

ISO-8601 timestamp of when the invitation was created.

tokenstring required

The opaque accept token.

acceptUrlstring required

The full URL a recipient uses to accept the invitation.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status