Create User Invitation REST Endpoint

POST api.ashx/v2/users/invitations.{json|xml}

CREATE a user invitation.

Scopes

Users › Modify Invitations users.invitations.modify

Request Parameters

Name	Type	Description	Required
Email	string	Email	Required
GroupId	int?	Group Id	Optional
GroupMembershipType	string	Options are: Owner, Manager, Member, PendingMember, EffectiveMember	Optional
Message	string	Message	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.post({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/invitations.json',
	data: { 
		'Email': 'email'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "UserInvitation": {
    "UserId": 6,
    "GroupId": 25,
    "GroupMembershipType": "groupmembershiptype",
    "Email": "email",
    "Message": "message",
    "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e"
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <UserInvitation>
    <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
    <UserId>6</UserId>
    <GroupId>25</GroupId>
    <GroupMembershipType>groupmembershiptype</GroupMembershipType>
    <Email>email</Email>
    <Message>message</Message>
  </UserInvitation>
</Response>

Recommended