Create and Delete a User via API

You can implement an API that will create and delete user to the Knowledge Base

In this article, you'll learn:

Create user API
Delete user API

1. How to Create user via API

Endpoint URL:

The endpoint URL given below is used to call the rest API. POST will be used as the request method. JSON will be your request format.

POST https://www.helpdocsonline.com/proprofsapi/user/v1

Request Parameters

Name	Required	Type	Description
api_key	Yes	String	Your private API key for the FAQ. The API key is available at: Settings > In-App Help > API key
action	Yes	String	Action of the API “create”
users	Yes	String/Array	You can create one user at a one time. Sample like email, name, role, access_sites, group 1. role: It can be any value from ‘Admin’, ‘Editor’, ‘Contributor’, ‘Viewer’. 2. access_sites: Allowed values are: 0 or 1. Pass 1 if you want to give access to all the sites and pass 0 if you don’t want to give access to any of the sites (it can be used when you don’t want to give access to all the sites, but wanted to give access according to any group) 3. group: Pass the group names here separated by comma (if more than one)

Sample Code | JSON

Accept: application/json
Content-Type: application/json
{
"api_key":  "<your API key>",
"action": "create",
"user":
{
"email": "sample@mycompany.com",
"name": "Sample",
"role":   "Contributor",
"access_sites":   0,
"group":   "groupName1,groupName2"
}
}

Sample Code | PHP Script

$data = array();
$data['api_key'] = '<your API key>';
$data['action'] = 'create';
$users= array('email'=>'sample@mycompany.com','name'=>'Sample','role'=>'Contributor','access_sites'=>0,'group'=>'groupName');
$data['users'] = array($user1);
echo json_encode($data);

Response Format

JSON

Example Response [Success]

Content-Type: application/json
[
{
"status": "SUCCESS",
"msg": "User added successfully"
}
]

Name	Required
status	Success
msg	User added successfully

2. How to delete user via API

Endpoint URL:

The endpoint URL given below is used to call the rest API. POST will be used as the request method. JSON will be your request format.

POST https://www.helpdocsonline.com/proprofsapi/user/v1

Request Parameters

Name	Required	Type	Description
api_key	Yes	String	Your private API key for the FAQ. The API key is available in the manage account section of the super admin.
action	Yes	String	Action of the API "delete"
users	Yes	String	Enter email id of the user which you want to delete.

Note: We can’t delete master user from this API.

Sample Code | JSON

Accept: application/json
Content-Type: application/json
{
"api_key": "<your API key>",
"action": "delete",
"user":
{
"email": "sample@mycompany.com"
}
}

Sample Code | PHP Script

$data = array();
$data['api_key'] = '<your API key>';
$data['action'] = 'delete';
$user= array('email'=>'sample@mycompany.com');
$data['users'] = array($user);
echo json_encode($data);

Response Format

JSON

Example Response [Success]

Content-Type: application/json
[
{
"status": "SUCCESS",
"msg": "User deleted successfully"
}
]

Name	Required
status	Success
msg	User deleted successfully