v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add Staff Account

Lets admin users to create a staff account for the organization.

post/staff

Headers

X-CAP-API-AUTH-KEYstring required

Authentication key of the admin.

X-CAP-API-AUTH-ORG-IDstring required

ID of the org to associate with the staff user.

Request body

usernamestring required

Username for the current staff account. No special characters are allowed.

mobilestring

Mobile number of the staff.

emailstring

Email ID of the staff.

passwordstring required

Password for the staff account.

storeCodestring

Specify the store code to which you want to associate the staff. If no store code is passed, the user is associated to the InfluenceStore by default store

zoneCodestring

Valid zone code of the store. If this is not passed, the zone will be associated according to the store code

ConceptCodestring

The concept code associated to the store. If this is not passed, the concept will be associated according to to the store code

firstnamestring

First name of the staff user

lastnamestring

Last name of the staff user.

rolestring

Role of the staff user.

Response

200

entityinteger

successboolean

Example response

{
  "entity": 75025585,
  "success": true
}