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
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":[{"attributes":{"created_at":"\u003cdateTime\u003e","expires_at":"\u003cdateTime\u003e","invite_type":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},"id":"\u003cstring\u003e","relationships":{"user":{"data":{"id":"\u003cstring\u003e","type":"users"}}},"type":"user_invitations"},{"attributes":{"created_at":"\u003cdateTime\u003e","expires_at":"\u003cdateTime\u003e","invite_type":"\u003cstring\u003e","uuid":"\u003cstring\u003e"},"id":"\u003cstring\u003e","relationships":{"user":{"data":{"id":"\u003cstring\u003e","type":"users"}}},"type":"user_invitations"}]}