Update an address
curl --request PATCH \
--url https://api.artu.ai/addresses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"data": {
"type": "home",
"isPrimary": true,
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"externalId": "<string>",
"metadata": {},
"scopeData": {
"MX": {
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"betweenStreets": "<string>",
"reference": "<string>",
"cnbv": {}
},
"US": "<unknown>"
}
}
}
'import requests
url = "https://api.artu.ai/addresses/{id}"
payload = { "data": {
"type": "home",
"isPrimary": True,
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"externalId": "<string>",
"metadata": {},
"scopeData": {
"MX": {
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"betweenStreets": "<string>",
"reference": "<string>",
"cnbv": {}
},
"US": "<unknown>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'home',
isPrimary: true,
street: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
externalId: '<string>',
metadata: {},
scopeData: {
MX: {
exteriorNumber: '<string>',
interiorNumber: '<string>',
neighborhood: '<string>',
municipality: '<string>',
betweenStreets: '<string>',
reference: '<string>',
cnbv: {}
},
US: '<unknown>'
}
}
})
};
fetch('https://api.artu.ai/addresses/{id}', 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.artu.ai/addresses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'home',
'isPrimary' => true,
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'externalId' => '<string>',
'metadata' => [
],
'scopeData' => [
'MX' => [
'exteriorNumber' => '<string>',
'interiorNumber' => '<string>',
'neighborhood' => '<string>',
'municipality' => '<string>',
'betweenStreets' => '<string>',
'reference' => '<string>',
'cnbv' => [
]
],
'US' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <api-key>"
],
]);
$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.artu.ai/addresses/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"home\",\n \"isPrimary\": true,\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"betweenStreets\": \"<string>\",\n \"reference\": \"<string>\",\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<api-key>")
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.patch("https://api.artu.ai/addresses/{id}")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"home\",\n \"isPrimary\": true,\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"betweenStreets\": \"<string>\",\n \"reference\": \"<string>\",\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/addresses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"home\",\n \"isPrimary\": true,\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"betweenStreets\": \"<string>\",\n \"reference\": \"<string>\",\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isPrimary": true,
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"scope": "base",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "home",
"country": "<unknown>",
"externalId": "<string>",
"metadata": {},
"scopeData": {
"MX": {
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"betweenStreets": "<string>",
"reference": "<string>",
"cnbv": {
"TRANSMISOR": {
"localidad": "10100005"
}
}
},
"US": "<unknown>"
}
}Addresses
Update an address
PATCH
/
addresses
/
{id}
Update an address
curl --request PATCH \
--url https://api.artu.ai/addresses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Environment: <api-key>' \
--data '
{
"data": {
"type": "home",
"isPrimary": true,
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"externalId": "<string>",
"metadata": {},
"scopeData": {
"MX": {
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"betweenStreets": "<string>",
"reference": "<string>",
"cnbv": {}
},
"US": "<unknown>"
}
}
}
'import requests
url = "https://api.artu.ai/addresses/{id}"
payload = { "data": {
"type": "home",
"isPrimary": True,
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"country": "<string>",
"externalId": "<string>",
"metadata": {},
"scopeData": {
"MX": {
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"betweenStreets": "<string>",
"reference": "<string>",
"cnbv": {}
},
"US": "<unknown>"
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Environment": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'X-Environment': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'home',
isPrimary: true,
street: '<string>',
city: '<string>',
state: '<string>',
postalCode: '<string>',
country: '<string>',
externalId: '<string>',
metadata: {},
scopeData: {
MX: {
exteriorNumber: '<string>',
interiorNumber: '<string>',
neighborhood: '<string>',
municipality: '<string>',
betweenStreets: '<string>',
reference: '<string>',
cnbv: {}
},
US: '<unknown>'
}
}
})
};
fetch('https://api.artu.ai/addresses/{id}', 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.artu.ai/addresses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'home',
'isPrimary' => true,
'street' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postalCode' => '<string>',
'country' => '<string>',
'externalId' => '<string>',
'metadata' => [
],
'scopeData' => [
'MX' => [
'exteriorNumber' => '<string>',
'interiorNumber' => '<string>',
'neighborhood' => '<string>',
'municipality' => '<string>',
'betweenStreets' => '<string>',
'reference' => '<string>',
'cnbv' => [
]
],
'US' => '<unknown>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Environment: <api-key>"
],
]);
$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.artu.ai/addresses/{id}"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"home\",\n \"isPrimary\": true,\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"betweenStreets\": \"<string>\",\n \"reference\": \"<string>\",\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Environment", "<api-key>")
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.patch("https://api.artu.ai/addresses/{id}")
.header("Authorization", "Bearer <token>")
.header("X-Environment", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"home\",\n \"isPrimary\": true,\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"betweenStreets\": \"<string>\",\n \"reference\": \"<string>\",\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.artu.ai/addresses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Environment"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"home\",\n \"isPrimary\": true,\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"country\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {},\n \"scopeData\": {\n \"MX\": {\n \"exteriorNumber\": \"<string>\",\n \"interiorNumber\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"municipality\": \"<string>\",\n \"betweenStreets\": \"<string>\",\n \"reference\": \"<string>\",\n \"cnbv\": {}\n },\n \"US\": \"<unknown>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isPrimary": true,
"street": "<string>",
"city": "<string>",
"state": "<string>",
"postalCode": "<string>",
"scope": "base",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "home",
"country": "<unknown>",
"externalId": "<string>",
"metadata": {},
"scopeData": {
"MX": {
"exteriorNumber": "<string>",
"interiorNumber": "<string>",
"neighborhood": "<string>",
"municipality": "<string>",
"betweenStreets": "<string>",
"reference": "<string>",
"cnbv": {
"TRANSMISOR": {
"localidad": "10100005"
}
}
},
"US": "<unknown>"
}
}Authorizations
API key authentication. Obtain your API key from the dashboard.
Target environment for the request. Must be "test" or "live".
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Response
200 - application/json
OK
Client ID
Street
Minimum string length:
1City
Minimum string length:
1State
Minimum string length:
1Postal Code
Minimum string length:
1Available options:
base, MX:AV, MX:AV:ARI, MX:AV:AVI, MX:AV:INM, MX:AV:JYS, MX:AV:MJR, MX:AV:MPC, MX:AV:TSC, MX:AV:VEH, MX:CNBV, MX:CNBV:TRANSMISOR, MX Type
Available options:
home, business, mailing, legal, other Country
External ID
Metadata
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
