Update basic information
curl --request PUT \
--url https://api.cadanapay.com/v1/persons/{personId}/basicInfo \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "John",
"lastName": "Doe",
"email": "<string>",
"phoneNumber": {
"countryCode": "1",
"number": "2345678901"
},
"metadata": {
"customField1": "value1",
"customField2": "value2"
}
}
'import requests
url = "https://api.cadanapay.com/v1/persons/{personId}/basicInfo"
payload = {
"firstName": "John",
"lastName": "Doe",
"email": "<string>",
"phoneNumber": {
"countryCode": "1",
"number": "2345678901"
},
"metadata": {
"customField1": "value1",
"customField2": "value2"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'John',
lastName: 'Doe',
email: '<string>',
phoneNumber: {countryCode: '1', number: '2345678901'},
metadata: {customField1: 'value1', customField2: 'value2'}
})
};
fetch('https://api.cadanapay.com/v1/persons/{personId}/basicInfo', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cadanapay.com/v1/persons/{personId}/basicInfo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'John',
'lastName' => 'Doe',
'email' => '<string>',
'phoneNumber' => [
'countryCode' => '1',
'number' => '2345678901'
],
'metadata' => [
'customField1' => 'value1',
'customField2' => 'value2'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cadanapay.com/v1/persons/{personId}/basicInfo"
payload := strings.NewReader("{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"<string>\",\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"number\": \"2345678901\"\n },\n \"metadata\": {\n \"customField1\": \"value1\",\n \"customField2\": \"value2\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.cadanapay.com/v1/persons/{personId}/basicInfo")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"<string>\",\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"number\": \"2345678901\"\n },\n \"metadata\": {\n \"customField1\": \"value1\",\n \"customField2\": \"value2\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cadanapay.com/v1/persons/{personId}/basicInfo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"<string>\",\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"number\": \"2345678901\"\n },\n \"metadata\": {\n \"customField1\": \"value1\",\n \"customField2\": \"value2\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}{
"code": "resource_not_found",
"message": "Requested resource could not be found."
}{
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}Persons
Update basic information
Update a person’s basic information
PUT
/
v1
/
persons
/
{personId}
/
basicInfo
Update basic information
curl --request PUT \
--url https://api.cadanapay.com/v1/persons/{personId}/basicInfo \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "John",
"lastName": "Doe",
"email": "<string>",
"phoneNumber": {
"countryCode": "1",
"number": "2345678901"
},
"metadata": {
"customField1": "value1",
"customField2": "value2"
}
}
'import requests
url = "https://api.cadanapay.com/v1/persons/{personId}/basicInfo"
payload = {
"firstName": "John",
"lastName": "Doe",
"email": "<string>",
"phoneNumber": {
"countryCode": "1",
"number": "2345678901"
},
"metadata": {
"customField1": "value1",
"customField2": "value2"
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: 'John',
lastName: 'Doe',
email: '<string>',
phoneNumber: {countryCode: '1', number: '2345678901'},
metadata: {customField1: 'value1', customField2: 'value2'}
})
};
fetch('https://api.cadanapay.com/v1/persons/{personId}/basicInfo', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.cadanapay.com/v1/persons/{personId}/basicInfo",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => 'John',
'lastName' => 'Doe',
'email' => '<string>',
'phoneNumber' => [
'countryCode' => '1',
'number' => '2345678901'
],
'metadata' => [
'customField1' => 'value1',
'customField2' => 'value2'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cadanapay.com/v1/persons/{personId}/basicInfo"
payload := strings.NewReader("{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"<string>\",\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"number\": \"2345678901\"\n },\n \"metadata\": {\n \"customField1\": \"value1\",\n \"customField2\": \"value2\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.cadanapay.com/v1/persons/{personId}/basicInfo")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"<string>\",\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"number\": \"2345678901\"\n },\n \"metadata\": {\n \"customField1\": \"value1\",\n \"customField2\": \"value2\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cadanapay.com/v1/persons/{personId}/basicInfo")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"<string>\",\n \"phoneNumber\": {\n \"countryCode\": \"1\",\n \"number\": \"2345678901\"\n },\n \"metadata\": {\n \"customField1\": \"value1\",\n \"customField2\": \"value2\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}{
"code": "resource_not_found",
"message": "Requested resource could not be found."
}{
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required when using a Platform API token. The tenant key identifying which business to operate on.
Path Parameters
The unique identifier for the person
Body
application/json
Update person basic info request payload
Person's first name
Example:
"John"
Person's last name
Example:
"Doe"
Person's email
Person's phone number
Show child attributes
Show child attributes
Optional metadata you can store as key-value pairs
Example:
{
"customField1": "value1",
"customField2": "value2"
}Response
Successful operation
⌘I