Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Change Identifier (Send OTP)

Sends a validation OTP to the registered mobile number/email id of the staff to change identifier.

Changing identifier involves two step -

  1. Send OTP to the new identifier (current API)
  2. Validate the OTP received to the new identifier (next API)
post/staff/changeidentifier/sendotp

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

identifierinteger required

Unique id created for the staff

type'mobile' | 'email' required

Identifier type used for OTP validation.

notesstring

Reason for identifier change.

Response

200

entityinteger
successboolean

Example response

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