User APIs

User API - Bulk - Invite

OVERVIEW

 

NOTE : This API endpoint is supported in version 5.0 onwards.

Overview

This API call is used to unlock users who are locked.

HTTP Request

PUT   /api/4/users?action=invite

HTTP Request Object

Request xml
<users> 
    <user> 
        <userid>102</userid>
        <userid>101</userid>
    </user>
    <email>

       <subject>

        invite subject

       </subject>
        <body> 
            Email content 
        </body>
    </email> 
</users>

Request JSON

{
    "user": {
        "userid": [
            "102",
            "101"
        ]
    },
    "email": {
        "body": "Email content",

         "subject" : "invite subject"
    }
}

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, XML is the default response given.

 "application/xml"
Content Type
  • application/xml
  • application/json
 "application/xml"

 

HTTP Response

Success

HTTP response 200 

Example HTTP Request & Response

PUT  http://example.com/context/api/4/users?action=invite

 

Error messages

Summary Ref Code (V4) Ref Code (before V4)
A User ID is required 109  
The following users do not exist within the system 110  
The given action cannot be performed on an anonymised user(s). 325  
User ID is not in proper format 113  
This given action is invalid. Please use unlock,invite or resetpassword 367  
The following users are not active in the system 395  

Comments


0 Comments

Last Updated: Nov 08,2024