groups

Invite a user to a group

Invites a user to a group and returns the invitation

post/accounts/{id}/group-invitations

Request

Base URL
https://api.webscale.com/v2
Auth
none declared
TypeScript
https://skmtc.dev/webscale/apis/webscale-apis/docs/accounts/:id/group-invitations/post.ts
A function with typed inputs. Its response is checked against the schema.

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 operation across all 1 revision of this API.