Create/Update Users

The Create/Update User API is designed for creating or updating user profiles within our platform. This process is crucial for maintaining accurate user data and ensuring efficient management across all system interactions.

warning

It is important to handle user data securely and ensure that access is restricted to authorized users only.

API Endpoint

Method: POST

URL: https://<PA_RM_END_POINT>/retail-media/users/{organisationId}/upsert-user

Request Header

Name	Value
Content-Type	application/json
Authorization	Bearer ACCESS_TOKEN

info

Please refer to the Authentication API documentation for bearer token.

Request Parameters

Parameter	Type	Description
organisationId	GUID	Organisation ID for the supplier or retailer whom the user will belongs.

Example Request Payload

{
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "firstName": "name of the user",
    "lastName": "last name of the user",
    "middleName": "middle name of the user",
    "userRole": "role of the user (admin/manager/member)",
    "password": "password",
    "email": "abc@particularaudience.com",
    "mobile": "Mobile",
    "countryCode": "country code"
}

Parameter	Type	Required	Description
id	GUID		Required for updating existing user information. To create a new user, exclude this field or set it to null
firstName	string	✅	First name of the user.
lastName	string	✅	Last name of the user.
middleName	string		Middle name of the user.
userRole	string	✅	Role of the user (admin/manager/member).
password	string		Storng password. Required when create the user.
email	string	✅	Email.
mobile	string	✅	Mobile number.
countryCode	string	✅	countryCode.

info

Currently there are three roles available for the user:

• admin
• manager
• member

Response Payload

Success Response

• Status Code: 200 OK
• Payload: Returns the success message of the operation in JSON format

{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "email": "johndoe@example.com"
}

Error Response

If an error occurs, the API will return an appropriate status code along with an error message.

• Sample Error Response (400 Bad Request):

{
  "errors": [
    "Error message 1",
    "Error message 2"
  ],
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "xxxxxxxxxxxxxxxxxxx"
}

Example Usage (JavaScript)

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "BEARER YOUR_ACCESS_TOKEN");

const body = JSON.stringify(
  {
    "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "firstName": "name of the user",
    "lastName": "last name of the user",
    "middleName": "middle name of the user",
    "userRole": "role of the user (admin/manager/member)",
    "password": "password",
    "email": "abc@particularaudience.com",
    "mobile": "Mobile",
    "countryCode": "country code"
}
)

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: body
};

fetch("https://<PA_RM_END_POINT>/retail-media/users/{organisationId}/upsert-user", requestOptions)
  .then(response => response.json())
  .then(result=> { 
    console.log(result);
  })
  .catch(error => console.log('error', error));

info

To create a new user, exclude the id field. To update an existing user, the id field is mandatory.