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.

• Method: POST

• URL: https://<PA_RM_END_POINT>/rm/1.0/user

• Headers:

  • Content-Type: application/json
  • Authorization: Bearer ACCESS_TOKEN

• Request Body Parameters:

  • id (GUID) : The primary identifier for the user.

    info

    id is required if updating and existing user. If the id is not provided, then a new user will be created.

  • organizationId (GUID) [REQUIRED]: The organization ID of the Retailer/Supplier that this User belongs to.

  • email (string) [REQUIRED]: The user's email address.

  • username (string) [REQUIRED]: The user's email address used as a username.

  • title (string): The user's title, e.g., Mr, Ms, etc.

  • firstname (string): The user's first name.

  • lastname (string): The user's last name.

  • mobile (string): The user's mobile phone number.

• Response Codes:

  • 200 OK

    Successful request. The response body will include user details and a message indicating success.

  • Non-200 Responses

    If an error occurs (e.g., bad request, unauthorized access), the server will respond with an appropriate non-200 status code and include an error message in the response body:

    {
        "error": "Error message"
    }