Update an iMessage Profile
curl --request PATCH \
--url https://api.getnexor.ai/api/public/imessage/numbers/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "<string>",
"firstName": "<string>",
"last_name": "<string>",
"lastName": "<string>",
"avatar_url": "<string>",
"avatarUrl": "<string>",
"internalName": "<string>"
}
'import requests
url = "https://api.getnexor.ai/api/public/imessage/numbers/{id}"
payload = {
"first_name": "<string>",
"firstName": "<string>",
"last_name": "<string>",
"lastName": "<string>",
"avatar_url": "<string>",
"avatarUrl": "<string>",
"internalName": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
firstName: '<string>',
last_name: '<string>',
lastName: '<string>',
avatar_url: '<string>',
avatarUrl: '<string>',
internalName: '<string>'
})
};
fetch('https://api.getnexor.ai/api/public/imessage/numbers/{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.getnexor.ai/api/public/imessage/numbers/{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([
'first_name' => '<string>',
'firstName' => '<string>',
'last_name' => '<string>',
'lastName' => '<string>',
'avatar_url' => '<string>',
'avatarUrl' => '<string>',
'internalName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.getnexor.ai/api/public/imessage/numbers/{id}"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"last_name\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"internalName\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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.getnexor.ai/api/public/imessage/numbers/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"last_name\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"internalName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/imessage/numbers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"last_name\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"internalName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"number": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "<string>",
"setupStatus": "<string>",
"setupError": "<string>",
"imessageWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": {
"workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"masterWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"masterName": "<string>"
},
"sharedWith": [
{
"workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"internalName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}{
"error": "<string>",
"message": "<string>",
"fieldErrors": {}
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}Update an iMessage Profile
This operation lets you update an iMessage profile for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.
PATCH
/
imessage
/
numbers
/
{id}
Update an iMessage Profile
curl --request PATCH \
--url https://api.getnexor.ai/api/public/imessage/numbers/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"first_name": "<string>",
"firstName": "<string>",
"last_name": "<string>",
"lastName": "<string>",
"avatar_url": "<string>",
"avatarUrl": "<string>",
"internalName": "<string>"
}
'import requests
url = "https://api.getnexor.ai/api/public/imessage/numbers/{id}"
payload = {
"first_name": "<string>",
"firstName": "<string>",
"last_name": "<string>",
"lastName": "<string>",
"avatar_url": "<string>",
"avatarUrl": "<string>",
"internalName": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
first_name: '<string>',
firstName: '<string>',
last_name: '<string>',
lastName: '<string>',
avatar_url: '<string>',
avatarUrl: '<string>',
internalName: '<string>'
})
};
fetch('https://api.getnexor.ai/api/public/imessage/numbers/{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.getnexor.ai/api/public/imessage/numbers/{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([
'first_name' => '<string>',
'firstName' => '<string>',
'last_name' => '<string>',
'lastName' => '<string>',
'avatar_url' => '<string>',
'avatarUrl' => '<string>',
'internalName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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.getnexor.ai/api/public/imessage/numbers/{id}"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"last_name\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"internalName\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<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.getnexor.ai/api/public/imessage/numbers/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"last_name\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"internalName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/imessage/numbers/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"firstName\": \"<string>\",\n \"last_name\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"internalName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"number": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "<string>",
"setupStatus": "<string>",
"setupError": "<string>",
"imessageWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"owner": {
"workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"masterWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"masterName": "<string>"
},
"sharedWith": [
{
"workflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"internalName": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"isActive": true,
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}{
"error": "<string>",
"message": "<string>",
"fieldErrors": {}
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}{
"error": "<string>",
"message": "<string>",
"declineReason": "<string>",
"declineCode": "<string>"
}Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
iMessage number id. Pinned handler checks only 36 hex-or-hyphen characters, not canonical UUID groups. Callers should send a real UUID.
Pattern:
^[0-9a-f-]{36}$Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Maximum string length:
30Maximum string length:
30Maximum string length:
30Maximum string length:
30Pattern:
^https?://Pattern:
^https?://Maximum string length:
80Last modified on September 8, 2026
⌘I