Sign in
groups

Invite a user to a group

Invites a user to a group and returns the invitation

post/accounts/{id}/group-invitations

Path parameters

idstring required

Account id

Request body

user_emailstring

An email address

groupstring

A reference to this group

Response

The invitation was successfully sent.

state'queued' | 'accepted' | 'sent' | 'declined'

The current state of the group invitation.

hrefstring

A reference to this group

createdstring

An iso8601 formatted timestamp

sentstring

An iso8601 formatted timestamp

granted_bystring

The user that sent the invitation

user_emailstring

An email address

groupstring

A reference to this group

Changes

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