Skip to main content
PUT
/
api
/
v1
/
contacts
/
{id}
Update Contact
curl --request PUT \
  --url http://localhost:8080/api/v1/contacts/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'first_name=<string>' \
  --form 'last_name=<string>' \
  --form [email protected] \
  --form 'phone_number=<string>' \
  --form 'phone_number_country_code=<string>' \
  --form 'avatar_url=<string>' \
  --form enabled=true \
  --form files=@example-file
{
  "status": "success",
  "data": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "[email protected]",
    "type": "<string>",
    "availability_status": "<string>",
    "avatar_url": "<string>",
    "phone_number": "<string>",
    "phone_number_country_code": "<string>",
    "custom_attributes": {},
    "enabled": true,
    "last_active_at": "2023-11-07T05:31:56Z",
    "last_login_at": "2023-11-07T05:31:56Z",
    "roles": [
      "<string>"
    ],
    "permissions": [
      "<string>"
    ],
    "teams": [
      {}
    ],
    "api_key": "<string>",
    "api_key_last_used_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Path Parameters

id
string
required

Body

multipart/form-data

Contact update details

first_name
string

Contact's first name

last_name
string

Contact's last name

email
string<email>

Contact's email address

phone_number
string

Contact's phone number

phone_number_country_code
string

ISO country code

files
file

New avatar image file to upload

avatar_url
string | null

URL of the contact's avatar image. Pass a valid image URL to update, pass null to remove the avatar, or pass the existing value to keep it unchanged.

enabled
boolean

Whether the contact is enabled

Response

Contact updated successfully

status
string
Example:

"success"

data
object
I