Manage User
Block and Unblock User

Block User

post
โ€Ž
https://<domain>/<api prefix>/<version>/block/user/

Sample Code

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/block/user/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Beare <access-token>'
},
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' => '<user_unique_id>'),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access-token>'
),
));
โ€‹
$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/

Sample Code

Node
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://<domain>/<api prefix>/<version>/unblock/user/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Beare <access-token>'
},
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' => '<user_unique_id>'),
CURLOPT_HTTPHEADER => array(
'apikey: <apikey>',
'Authorization: Bearer <access-token>'
),
));
โ€‹
$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.
โ€‹