Send invitation emails

POST {{baseUrl}}/api/v2/user_invitations

Sends emails to one or more users inviting them to join the organization.

Request Body

{"data"=>[{"type"=>"user_invitations", "relationships"=>{"user"=>{"data"=>{"id"=>"<string>", "type"=>"users"}}}}, {"type"=>"user_invitations", "relationships"=>{"user"=>{"data"=>{"id"=>"<string>", "type"=>"users"}}}}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;data&quot;:[{&quot;attributes&quot;:{&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;expires_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;invite_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;uuid&quot;:&quot;\u003cstring\u003e&quot;},&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;relationships&quot;:{&quot;user&quot;:{&quot;data&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;users&quot;}}},&quot;type&quot;:&quot;user_invitations&quot;},{&quot;attributes&quot;:{&quot;created_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;expires_at&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;invite_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;uuid&quot;:&quot;\u003cstring\u003e&quot;},&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;relationships&quot;:{&quot;user&quot;:{&quot;data&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;users&quot;}}},&quot;type&quot;:&quot;user_invitations&quot;}]}