Manage User

Block and Unblock User

Block User

post

https://<domain>/<api prefix>/<version>/block/user/
This API endpoint will block a user account.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access token
Body Parameters
unique_id
required
string
Unique key of user.
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}

Sample Code

Node

var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/block/user/',
'headers': {
'apikey': '<apikey>'
},
formData: {
'unique_id': '<user_unique_id>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});

PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/block/user/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('unique_id' => '<>'),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Error Responses

Status Code

Error Type

Field

Description

400

Validation Error

unique_id

This field is required and its may not be blank.

User not exist or invalid unique id.

Ensure this field has no more than 255 characters.

Unblock User

post

https://<domain>/<api prefix>/<version>/unblock/user/
This API endpoint will unblock a user.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access token
Body Parameters
unique_id
required
string
Unique key of user.
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
Body:
{
"status_code": 200,
"errors": {},
"data": {}
}

Sample Code

Node

var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/unblock/user/',
'headers': {
'apikey': '<apikey>'
},
formData: {
'unique_id': '<user_unique_id>'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});

PHP

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/unblock/user/',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('unique_id' => '<>'),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Error Responses

Status Code

Error Type

Field

Description

400

Validation Error

unique_id

This field is required and its may not be blank.

User not exist or invalid unique id.

Ensure this field has no more than 255 characters.