Update a contact

curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/contacts/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John",
  "surname": "Doe",
  "email": "john.doe@example.com",
  "phone_number": "+12345678901",
  "number_type": "mobile",
  "country_code": "US",
  "timezone": "America/New_York",
  "primary_language": "en",
  "preferred_contact_channel": "email",
  "preferred_contact_time": "Morning",
  "status": "Active"
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/contacts/{uuid}"

payload = {
    "name": "John",
    "surname": "Doe",
    "email": "john.doe@example.com",
    "phone_number": "+12345678901",
    "number_type": "mobile",
    "country_code": "US",
    "timezone": "America/New_York",
    "primary_language": "en",
    "preferred_contact_channel": "email",
    "preferred_contact_time": "Morning",
    "status": "Active"
}
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({
    name: 'John',
    surname: 'Doe',
    email: 'john.doe@example.com',
    phone_number: '+12345678901',
    number_type: 'mobile',
    country_code: 'US',
    timezone: 'America/New_York',
    primary_language: 'en',
    preferred_contact_channel: 'email',
    preferred_contact_time: 'Morning',
    status: 'Active'
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/contacts/{uuid}', 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://{subdomain}.mihu.ai/api/v1/contacts/{uuid}",
  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([
    'name' => 'John',
    'surname' => 'Doe',
    'email' => 'john.doe@example.com',
    'phone_number' => '+12345678901',
    'number_type' => 'mobile',
    'country_code' => 'US',
    'timezone' => 'America/New_York',
    'primary_language' => 'en',
    'preferred_contact_channel' => 'email',
    'preferred_contact_time' => 'Morning',
    'status' => 'Active'
  ]),
  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://{subdomain}.mihu.ai/api/v1/contacts/{uuid}"

	payload := strings.NewReader("{\n  \"name\": \"John\",\n  \"surname\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone_number\": \"+12345678901\",\n  \"number_type\": \"mobile\",\n  \"country_code\": \"US\",\n  \"timezone\": \"America/New_York\",\n  \"primary_language\": \"en\",\n  \"preferred_contact_channel\": \"email\",\n  \"preferred_contact_time\": \"Morning\",\n  \"status\": \"Active\"\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://{subdomain}.mihu.ai/api/v1/contacts/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John\",\n  \"surname\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone_number\": \"+12345678901\",\n  \"number_type\": \"mobile\",\n  \"country_code\": \"US\",\n  \"timezone\": \"America/New_York\",\n  \"primary_language\": \"en\",\n  \"preferred_contact_channel\": \"email\",\n  \"preferred_contact_time\": \"Morning\",\n  \"status\": \"Active\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/contacts/{uuid}")

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  \"name\": \"John\",\n  \"surname\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone_number\": \"+12345678901\",\n  \"number_type\": \"mobile\",\n  \"country_code\": \"US\",\n  \"timezone\": \"America/New_York\",\n  \"primary_language\": \"en\",\n  \"preferred_contact_channel\": \"email\",\n  \"preferred_contact_time\": \"Morning\",\n  \"status\": \"Active\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Contact updated successfully",
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "surname": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "number_type": "<string>",
    "country_code": "<string>",
    "timezone": "<string>",
    "primary_language": "<string>",
    "preferred_contact_channel": "<string>",
    "preferred_contact_time": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "Contact not found",
  "data": [
    "<unknown>"
  ]
}

{
  "success": false,
  "message": "Another contact with this email already exists",
  "data": [
    "<unknown>"
  ]
}

{
  "success": false,
  "message": "Validation errors",
  "data": [
    "<unknown>"
  ]
}

{
  "success": false,
  "message": "An unexpected error occurred",
  "data": [
    "<unknown>"
  ]
}

Contacts

Update a contact

Updates base contact fields and custom field values. Use this to correct contact identity, phone/email, timezone, language, preferred channel, or status. Only supplied fields are changed.

Custom fields: any custom field key registered via POST /api/v1/contacts/fields can be sent as a top-level body property (string value). Sending an empty string or null clears that field for the contact. Use GET /api/v1/contacts/fields to discover available keys. Unknown keys return 422 with the offending key listed. In responses, every active custom field is returned as a top-level key — fields with no value appear as an empty string.

PUT

api

contacts

{uuid}

Update a contact

curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/contacts/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John",
  "surname": "Doe",
  "email": "john.doe@example.com",
  "phone_number": "+12345678901",
  "number_type": "mobile",
  "country_code": "US",
  "timezone": "America/New_York",
  "primary_language": "en",
  "preferred_contact_channel": "email",
  "preferred_contact_time": "Morning",
  "status": "Active"
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/contacts/{uuid}"

payload = {
    "name": "John",
    "surname": "Doe",
    "email": "john.doe@example.com",
    "phone_number": "+12345678901",
    "number_type": "mobile",
    "country_code": "US",
    "timezone": "America/New_York",
    "primary_language": "en",
    "preferred_contact_channel": "email",
    "preferred_contact_time": "Morning",
    "status": "Active"
}
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({
    name: 'John',
    surname: 'Doe',
    email: 'john.doe@example.com',
    phone_number: '+12345678901',
    number_type: 'mobile',
    country_code: 'US',
    timezone: 'America/New_York',
    primary_language: 'en',
    preferred_contact_channel: 'email',
    preferred_contact_time: 'Morning',
    status: 'Active'
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/contacts/{uuid}', 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://{subdomain}.mihu.ai/api/v1/contacts/{uuid}",
  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([
    'name' => 'John',
    'surname' => 'Doe',
    'email' => 'john.doe@example.com',
    'phone_number' => '+12345678901',
    'number_type' => 'mobile',
    'country_code' => 'US',
    'timezone' => 'America/New_York',
    'primary_language' => 'en',
    'preferred_contact_channel' => 'email',
    'preferred_contact_time' => 'Morning',
    'status' => 'Active'
  ]),
  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://{subdomain}.mihu.ai/api/v1/contacts/{uuid}"

	payload := strings.NewReader("{\n  \"name\": \"John\",\n  \"surname\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone_number\": \"+12345678901\",\n  \"number_type\": \"mobile\",\n  \"country_code\": \"US\",\n  \"timezone\": \"America/New_York\",\n  \"primary_language\": \"en\",\n  \"preferred_contact_channel\": \"email\",\n  \"preferred_contact_time\": \"Morning\",\n  \"status\": \"Active\"\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://{subdomain}.mihu.ai/api/v1/contacts/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John\",\n  \"surname\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone_number\": \"+12345678901\",\n  \"number_type\": \"mobile\",\n  \"country_code\": \"US\",\n  \"timezone\": \"America/New_York\",\n  \"primary_language\": \"en\",\n  \"preferred_contact_channel\": \"email\",\n  \"preferred_contact_time\": \"Morning\",\n  \"status\": \"Active\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/contacts/{uuid}")

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  \"name\": \"John\",\n  \"surname\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"phone_number\": \"+12345678901\",\n  \"number_type\": \"mobile\",\n  \"country_code\": \"US\",\n  \"timezone\": \"America/New_York\",\n  \"primary_language\": \"en\",\n  \"preferred_contact_channel\": \"email\",\n  \"preferred_contact_time\": \"Morning\",\n  \"status\": \"Active\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Contact updated successfully",
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "surname": "<string>",
    "email": "<string>",
    "phone_number": "<string>",
    "number_type": "<string>",
    "country_code": "<string>",
    "timezone": "<string>",
    "primary_language": "<string>",
    "preferred_contact_channel": "<string>",
    "preferred_contact_time": "<string>",
    "status": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "Contact not found",
  "data": [
    "<unknown>"
  ]
}

{
  "success": false,
  "message": "Another contact with this email already exists",
  "data": [
    "<unknown>"
  ]
}

{
  "success": false,
  "message": "Validation errors",
  "data": [
    "<unknown>"
  ]
}

{
  "success": false,
  "message": "An unexpected error occurred",
  "data": [
    "<unknown>"
  ]
}

Authorizations

Authorization

string

header

required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

uuid

string<uuid>

required

UUID of the contact to update

Body

application/json

name

string

Example:

"John"

surname

string

Example:

"Doe"

string<email>

Example:

"john.doe@example.com"

phone_number

string

Example:

"+12345678901"

number_type

string | null

Example:

"mobile"

country_code

string

Example:

"US"

timezone

string

Example:

"America/New_York"

primary_language

string

Example:

"en"

preferred_contact_channel

string

Example:

"email"

preferred_contact_time

string

Example:

"Morning"

status

enum<string>

Available options:

Active,

Inactive

Example:

"Active"

Response

Success

success

boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message

string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Contact updated successfully"

data

object

Show child attributes

Get contact details Delete a contact

API Documentation

API Reference

Update a contact

Authorizations

Path Parameters

Body

Response