About User

Get and Update User Additional Details.

Get User Additional Details

get
​

β€Žhttps://<domain>/<api prefix>/<version>/user/get/additional-info/
This API endpoint will give you the user additional information details.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access-token
Response
200: OK
HTTP/1.1 200 OK
Content-Type: application/json
​
Body:
{
"status_code": 200,
"errors": {},
"data": {
"AdditionalInfo": {
"about": "<about>",
"linkedin": "<linkedin-id>",
"facebook": "<facebook-id>",
"instagram": "<instagram-id>"
}
}
}

Sample code

Node

var request = require('request');
var options = {
'method': 'GET',
'url': 'https://<domain>/<api prefix>/<version>/user/get/additional-info/',
'headers': {
'apikey': '<apikey>',
'Authorization': 'Bearer <access-token>',
},
formData: {}
};
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/get/additional-info/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"apikey: <apikey>",
"Authorization: Bearer <access-token>",
),
));
​
$response = curl_exec($curl);
​
curl_close($curl);
echo $response;

β€Žβ€Žβ€Žβ€Žβ€ŽUpdate User Additional Details

post
​

β€Žhttps://<domain>/<api prefix>/<version>/user/manage/additional-info/
This API endpoint will update user additional details.
Request
Response
Request
Headers
apikey
required
string
apikey
Authorization
required
string
Bearer access-token
Body Parameters
about
required
string
user about
facebook
required
string
facebook-id
instagram
required
string
instagram-id
linkedin
required
string
linkedin-id
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>/manage/additional-info/',
'headers': {
'apikey': 'apikey',
'Authorization': 'Bearer <access-token>',
},
formData: {
'linkedin': '<linkedin-id>',
'facebook': '<facebook-id>',
'instagram': '<instagram-id>',
'about': '<about>'
}
};
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/manage/additional-info/",
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('linkedin' => '<linkedin-id>','facebook' => '<facebook-id >','instagram' => '<instagram-id>','about' => '<about>'),
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

about, facebook, instagram, linkedin

Ensure this field has no more than 500 characters.400 Validation Error about, facebook, instagram, linkedin Ensure this field has no more than 500 characters.

400

Validation Error

about, facebook, instagram, linkedin

This field may not be blank.