Place Genealogy
POST
https://<domain>/<api prefix>/<version>/user/place-user-genealogy/
This endpoint will place the user to genealogy
Headers
Name
Type
Description
apikey*
string
apikey
Authorization*
string
Bearer access token
Request Body
Name
Type
Description
uid*
string
user id
​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>/user/place-user-genealogy/',
'headers': {
'apikey': '<apikey>'
},
formData: {
'uid': '<user 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>/user/place-user-genealogy/',
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('uid' => '<user 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
uid
This field is required.
400
Validation Error
uid
User already placed in genealogy.
400
Validation Error
uid
Invalid uid. Please check again.
Last updated
Was this helpful?