User

This page provides APIs to manage users in Saleschat, including adding users, resetting passwords, generating magic links, and fetching user details.

Create a user and add it to the org

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

• ask_user_to_update_password_on_login: Default value is False

• emailConfirmed: User's email will be considered to be confirmed

• Email to confirm email will not be sent

• Role of the user added will be Member

• Sometimes a user may be created without being added to the org and will have to be handled manually

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

Body

application/json

emailstring · max: 319Required

passwordstring · min: 8 · max: 64Required

ask_user_to_update_password_on_loginbooleanOptional

first_namestring · max: 40Required

last_namestring · max: 40Required

Responses

200

User created successfully

application/json

user_idstringOptional

401

Unauthorized - Authentication is required

application/json

403

Forbidden: Unauthorized access

application/json

422

Required fields are missing or invalid values are provided

application/json

500

Internal error

application/json

post/v1/org/{orgId}/user

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/user HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "email": "text",
  "password": "text",
  "ask_user_to_update_password_on_login": true,
  "first_name": "text",
  "last_name": "text"
}

{
  "user_id": "text"
}

Reset a users password

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: True

• Partner Allowed: True

• User will be required to reset the password on next login

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

userIdstringRequired

Body

application/json

passwordstringRequired

ask_user_to_update_password_on_loginbooleanOptional

Responses

204

Successfully reset

No content

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

404

UserId does not exist for this org

application/json

422

Required fields are missing or invalid values are provided

application/json

500

Internal Server Error - Something went wrong on the server

application/json

post/v1/org/{orgId}/user/{userId}/password/reset

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/user/{userId}/password/reset HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "password": "text",
  "ask_user_to_update_password_on_login": true
}

No content

Generate a magic link for a user

get

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

userIdstringRequired

Responses

200

Successfully generated magic link

application/json

urlstringOptional

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

404

UserId does not exist for this org or user has been deleted

application/json

500

Internal server error

application/json

get/v1/org/{orgId}/user/{userId}/magiclink

HTTPcURLJavaScriptPython

GET /v1/org/{orgId}/user/{userId}/magiclink HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "url": "text"
}

Get user by email

get

• Roles Allowed: MEMBER

• Impersonated User Allowed: True

• Partner Allowed: True

• Supports Partial match on email ID

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

Query parameters

qstringRequiredDefault: ""

offsetinteger · int32OptionalDefault: 0

sizeinteger · int32OptionalDefault: 10

Responses

200

Successfully fetched user for email ID

application/json

has_morebooleanOptional

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

500

Internal server error

application/json

get/v1/org/{orgId}/user

HTTPcURLJavaScriptPython

GET /v1/org/{orgId}/user?q= HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "text",
      "email": "text",
      "first_name": "text",
      "last_name": "text"
    }
  ],
  "has_more": true
}

Delete a user

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

userIdstringRequired

Responses

204

Successfully deleted

No content

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

404

User Id does not exist

application/json

500

Internal Server Error - Something went wrong on the server

application/json

post/v1/org/{orgId}/user/{userId}/delete

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/user/{userId}/delete HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Disable a user

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

userIdstringRequired

Responses

204

Successfully disabled

No content

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

404

userId does not exist for this org

application/json

500

Internal Server Error - Something went wrong on the server

application/json

post/v1/org/{orgId}/user/{userId}/disable

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/user/{userId}/disable HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Enable a user

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

userIdstringRequired

Responses

204

Successfully enabled

No content

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

404

userId does not exist for this org

application/json

500

Internal Server Error - Something went wrong on the server

application/json

post/v1/org/{orgId}/user/{userId}/enable

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/user/{userId}/enable HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content