Update contact

PUT

contact

{id}

Update Contact

curl --request PUT \
  --url https://api.heymarket.com/v1/contact/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "12345678900",
  "avatar": "https://some.image.url.com/img.jpg",
  "custom": {},
  "display_name": "John Smith",
  "email": "john.s@heymarket.com",
  "first": "John",
  "last": "Smith",
  "external_id": "<string>",
  "type": "<string>",
  "timezone": "America/New_York",
  "assignee_id": 42,
  "tags": [
    {
      "tag_id": 1
    },
    {
      "tag_id": 2
    }
  ],
  "is_opted_out": true
}
'

import requests

url = "https://api.heymarket.com/v1/contact/{id}"

payload = {
    "phone": "12345678900",
    "avatar": "https://some.image.url.com/img.jpg",
    "custom": {},
    "display_name": "John Smith",
    "email": "john.s@heymarket.com",
    "first": "John",
    "last": "Smith",
    "external_id": "<string>",
    "type": "<string>",
    "timezone": "America/New_York",
    "assignee_id": 42,
    "tags": [{ "tag_id": 1 }, { "tag_id": 2 }],
    "is_opted_out": True
}
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({
    phone: '12345678900',
    avatar: 'https://some.image.url.com/img.jpg',
    custom: {},
    display_name: 'John Smith',
    email: 'john.s@heymarket.com',
    first: 'John',
    last: 'Smith',
    external_id: '<string>',
    type: '<string>',
    timezone: 'America/New_York',
    assignee_id: 42,
    tags: [{tag_id: 1}, {tag_id: 2}],
    is_opted_out: true
  })
};

fetch('https://api.heymarket.com/v1/contact/{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.heymarket.com/v1/contact/{id}",
  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([
    'phone' => '12345678900',
    'avatar' => 'https://some.image.url.com/img.jpg',
    'custom' => [
        
    ],
    'display_name' => 'John Smith',
    'email' => 'john.s@heymarket.com',
    'first' => 'John',
    'last' => 'Smith',
    'external_id' => '<string>',
    'type' => '<string>',
    'timezone' => 'America/New_York',
    'assignee_id' => 42,
    'tags' => [
        [
                'tag_id' => 1
        ],
        [
                'tag_id' => 2
        ]
    ],
    'is_opted_out' => true
  ]),
  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://api.heymarket.com/v1/contact/{id}"

	payload := strings.NewReader("{\n  \"phone\": \"12345678900\",\n  \"avatar\": \"https://some.image.url.com/img.jpg\",\n  \"custom\": {},\n  \"display_name\": \"John Smith\",\n  \"email\": \"john.s@heymarket.com\",\n  \"first\": \"John\",\n  \"last\": \"Smith\",\n  \"external_id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"timezone\": \"America/New_York\",\n  \"assignee_id\": 42,\n  \"tags\": [\n    {\n      \"tag_id\": 1\n    },\n    {\n      \"tag_id\": 2\n    }\n  ],\n  \"is_opted_out\": true\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://api.heymarket.com/v1/contact/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"12345678900\",\n  \"avatar\": \"https://some.image.url.com/img.jpg\",\n  \"custom\": {},\n  \"display_name\": \"John Smith\",\n  \"email\": \"john.s@heymarket.com\",\n  \"first\": \"John\",\n  \"last\": \"Smith\",\n  \"external_id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"timezone\": \"America/New_York\",\n  \"assignee_id\": 42,\n  \"tags\": [\n    {\n      \"tag_id\": 1\n    },\n    {\n      \"tag_id\": 2\n    }\n  ],\n  \"is_opted_out\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heymarket.com/v1/contact/{id}")

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  \"phone\": \"12345678900\",\n  \"avatar\": \"https://some.image.url.com/img.jpg\",\n  \"custom\": {},\n  \"display_name\": \"John Smith\",\n  \"email\": \"john.s@heymarket.com\",\n  \"first\": \"John\",\n  \"last\": \"Smith\",\n  \"external_id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"timezone\": \"America/New_York\",\n  \"assignee_id\": 42,\n  \"tags\": [\n    {\n      \"tag_id\": 1\n    },\n    {\n      \"tag_id\": 2\n    }\n  ],\n  \"is_opted_out\": true\n}"

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

{
  "id": 123,
  "rev": 123,
  "uuid": "<string>"
}

"<string>"

"Unauthorized"

"too many requests"

"error"

Use this endpoint to update a v1 contact. The overwrite query parameter controls whether custom fields are merged or replaced.

Authorizations

Authorization

string

header

required

Recommended authentication for new integrations. Generate a short-lived JWT from your API Secret ID and API Secret Key, then pass the signed JWT as a bearer token in the Authorization header.

API Secret credentials are available in the Heymarket app under Settings > Integrations > API. The Secret Key is shown only when it is generated, so copy and store it securely before closing the dialog.

Use the following JWT values:

{
  "alg": "HS256",
  "typ": "JWT"
}

{
  "iss": "YOUR_API_SECRET_ID",
  "iat": CURRENT_UNIX_TIMESTAMP
}

Replace CURRENT_UNIX_TIMESTAMP with the current Unix timestamp in seconds when generating the token.

Sign the JWT with HMAC-SHA256 using this signing secret:

YOUR_API_SECRET_ID||YOUR_API_SECRET_KEY

Send the signed JWT as a bearer token:

Authorization: Bearer YOUR_SIGNED_JWT

Tokens expire 5 minutes after the iat timestamp. Generate a new JWT per request, or cache it briefly for less than 5 minutes. Generate JWTs only from trusted server-side code; do not expose the API Secret Key in browser, mobile, or other client-side code.

Path Parameters

integer

required

Contact ID

Query Parameters

overwrite

boolean

Overwrite existing custom fields. Note that the contact's name is overwritten regardless of this parameter

Body

application/json

Contact json

phone

string<phone>

required

Example:

"12345678900"

avatar

string<url>

Example:

"https://some.image.url.com/img.jpg"

custom

object

display_name

string

Example:

"John Smith"

string<email>

Example:

"john.s@heymarket.com"

first

string

Example:

"John"

last

string

Example:

"Smith"

external_id

string

External Contact ID

type

string

External Service

timezone

string

IANA timezone for the contact (e.g., America/New_York)

Example:

"America/New_York"

assignee_id

integer

Example:

42

Response

integer

rev

integer

uuid

string

Create contact fields

Update contact (v2)

Update Contact

curl --request PUT \
  --url https://api.heymarket.com/v1/contact/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone": "12345678900",
  "avatar": "https://some.image.url.com/img.jpg",
  "custom": {},
  "display_name": "John Smith",
  "email": "john.s@heymarket.com",
  "first": "John",
  "last": "Smith",
  "external_id": "<string>",
  "type": "<string>",
  "timezone": "America/New_York",
  "assignee_id": 42,
  "tags": [
    {
      "tag_id": 1
    },
    {
      "tag_id": 2
    }
  ],
  "is_opted_out": true
}
'

import requests

url = "https://api.heymarket.com/v1/contact/{id}"

payload = {
    "phone": "12345678900",
    "avatar": "https://some.image.url.com/img.jpg",
    "custom": {},
    "display_name": "John Smith",
    "email": "john.s@heymarket.com",
    "first": "John",
    "last": "Smith",
    "external_id": "<string>",
    "type": "<string>",
    "timezone": "America/New_York",
    "assignee_id": 42,
    "tags": [{ "tag_id": 1 }, { "tag_id": 2 }],
    "is_opted_out": True
}
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({
    phone: '12345678900',
    avatar: 'https://some.image.url.com/img.jpg',
    custom: {},
    display_name: 'John Smith',
    email: 'john.s@heymarket.com',
    first: 'John',
    last: 'Smith',
    external_id: '<string>',
    type: '<string>',
    timezone: 'America/New_York',
    assignee_id: 42,
    tags: [{tag_id: 1}, {tag_id: 2}],
    is_opted_out: true
  })
};

fetch('https://api.heymarket.com/v1/contact/{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.heymarket.com/v1/contact/{id}",
  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([
    'phone' => '12345678900',
    'avatar' => 'https://some.image.url.com/img.jpg',
    'custom' => [
        
    ],
    'display_name' => 'John Smith',
    'email' => 'john.s@heymarket.com',
    'first' => 'John',
    'last' => 'Smith',
    'external_id' => '<string>',
    'type' => '<string>',
    'timezone' => 'America/New_York',
    'assignee_id' => 42,
    'tags' => [
        [
                'tag_id' => 1
        ],
        [
                'tag_id' => 2
        ]
    ],
    'is_opted_out' => true
  ]),
  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://api.heymarket.com/v1/contact/{id}"

	payload := strings.NewReader("{\n  \"phone\": \"12345678900\",\n  \"avatar\": \"https://some.image.url.com/img.jpg\",\n  \"custom\": {},\n  \"display_name\": \"John Smith\",\n  \"email\": \"john.s@heymarket.com\",\n  \"first\": \"John\",\n  \"last\": \"Smith\",\n  \"external_id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"timezone\": \"America/New_York\",\n  \"assignee_id\": 42,\n  \"tags\": [\n    {\n      \"tag_id\": 1\n    },\n    {\n      \"tag_id\": 2\n    }\n  ],\n  \"is_opted_out\": true\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://api.heymarket.com/v1/contact/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phone\": \"12345678900\",\n  \"avatar\": \"https://some.image.url.com/img.jpg\",\n  \"custom\": {},\n  \"display_name\": \"John Smith\",\n  \"email\": \"john.s@heymarket.com\",\n  \"first\": \"John\",\n  \"last\": \"Smith\",\n  \"external_id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"timezone\": \"America/New_York\",\n  \"assignee_id\": 42,\n  \"tags\": [\n    {\n      \"tag_id\": 1\n    },\n    {\n      \"tag_id\": 2\n    }\n  ],\n  \"is_opted_out\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heymarket.com/v1/contact/{id}")

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  \"phone\": \"12345678900\",\n  \"avatar\": \"https://some.image.url.com/img.jpg\",\n  \"custom\": {},\n  \"display_name\": \"John Smith\",\n  \"email\": \"john.s@heymarket.com\",\n  \"first\": \"John\",\n  \"last\": \"Smith\",\n  \"external_id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"timezone\": \"America/New_York\",\n  \"assignee_id\": 42,\n  \"tags\": [\n    {\n      \"tag_id\": 1\n    },\n    {\n      \"tag_id\": 2\n    }\n  ],\n  \"is_opted_out\": true\n}"

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

{
  "id": 123,
  "rev": 123,
  "uuid": "<string>"
}

"<string>"

"Unauthorized"

"too many requests"

"error"

Contacts

Messages

Links

Conversations

Lists & Templates

Other Resources

Authorizations

Path Parameters

Query Parameters

Body

Response