Skip to main content
PATCH
Update an iMessage Profile

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string
required

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
first_name
string | null
required
Maximum string length: 30
firstName
string | null
Maximum string length: 30
last_name
string | null
Maximum string length: 30
lastName
string | null
Maximum string length: 30
avatar_url
string<uri>
Pattern: ^https?://
avatarUrl
string<uri>
Pattern: ^https?://
internalName
string | null
Maximum string length: 80

Response

Updated number detail.

success
enum<boolean>
required
Available options:
true
number
object
required
Last modified on September 8, 2026