Skip to main content
PATCH
/
contacts
/
{contactId}
Update a contact by ID
curl --request PATCH \
  --url https://messenger-public-api.cogfy.com/contacts/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "occupation": "<string>",
  "gender": "<string>",
  "birthdate": "2023-12-25",
  "age": 123,
  "notes": "<string>",
  "customProperties": {
    "Favorite Color": "Blue"
  }
}
'
import requests

url = "https://messenger-public-api.cogfy.com/contacts/{contactId}"

payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"occupation": "<string>",
"gender": "<string>",
"birthdate": "2023-12-25",
"age": 123,
"notes": "<string>",
"customProperties": { "Favorite Color": "Blue" }
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
occupation: '<string>',
gender: '<string>',
birthdate: '2023-12-25',
age: 123,
notes: '<string>',
customProperties: {'Favorite Color': 'Blue'}
})
};

fetch('https://messenger-public-api.cogfy.com/contacts/{contactId}', 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://messenger-public-api.cogfy.com/contacts/{contactId}",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'occupation' => '<string>',
'gender' => '<string>',
'birthdate' => '2023-12-25',
'age' => 123,
'notes' => '<string>',
'customProperties' => [
'Favorite Color' => 'Blue'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://messenger-public-api.cogfy.com/contacts/{contactId}"

payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"occupation\": \"<string>\",\n \"gender\": \"<string>\",\n \"birthdate\": \"2023-12-25\",\n \"age\": 123,\n \"notes\": \"<string>\",\n \"customProperties\": {\n \"Favorite Color\": \"Blue\"\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("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://messenger-public-api.cogfy.com/contacts/{contactId}")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"occupation\": \"<string>\",\n \"gender\": \"<string>\",\n \"birthdate\": \"2023-12-25\",\n \"age\": 123,\n \"notes\": \"<string>\",\n \"customProperties\": {\n \"Favorite Color\": \"Blue\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://messenger-public-api.cogfy.com/contacts/{contactId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"occupation\": \"<string>\",\n \"gender\": \"<string>\",\n \"birthdate\": \"2023-12-25\",\n \"age\": 123,\n \"notes\": \"<string>\",\n \"customProperties\": {\n \"Favorite Color\": \"Blue\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
"message": "<string>"
}

Authorizations

api-key
string
header
required

Path Parameters

contactId
string<uuid>
required

Body

application/json
firstName
string
lastName
string
email
string<email>
phone
string
occupation
string
gender
string
birthdate
string<date>
age
integer
notes
string
customProperties
object

Custom properties associated with the contact

Example:
{ "Favorite Color": "Blue" }

Response

Contact updated successfully

id
string<uuid>