Skip to main content
POST
/
v2
/
contacts
Bulk Create Contacts (V2)
curl --request POST \
  --url https://api.heymarket.com/v2/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contacts": [
    {
      "contact_channels": [
        {
          "channel_type": "phone",
          "channel_id": "14155551234",
          "channel_ids": [
            "<string>"
          ],
          "channel_handle": "<string>",
          "info_channel": "<string>"
        }
      ],
      "avatar": "https://some.image.url.com/img.jpg",
      "custom": {},
      "display_name": "John Smith",
      "first": "John",
      "last": "Smith",
      "assignee_id": 42,
      "tags": [
        {
          "tag_id": 1
        },
        {
          "tag_id": 2
        }
      ],
      "is_opted_out": true,
      "email_suppressions": [
        123
      ],
      "timezone": "America/New_York"
    }
  ]
}
'
import requests

url = "https://api.heymarket.com/v2/contacts"

payload = { "contacts": [
        {
            "contact_channels": [
                {
                    "channel_type": "phone",
                    "channel_id": "14155551234",
                    "channel_ids": ["<string>"],
                    "channel_handle": "<string>",
                    "info_channel": "<string>"
                }
            ],
            "avatar": "https://some.image.url.com/img.jpg",
            "custom": {},
            "display_name": "John Smith",
            "first": "John",
            "last": "Smith",
            "assignee_id": 42,
            "tags": [{ "tag_id": 1 }, { "tag_id": 2 }],
            "is_opted_out": True,
            "email_suppressions": [123],
            "timezone": "America/New_York"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contacts: [
      {
        contact_channels: [
          {
            channel_type: 'phone',
            channel_id: '14155551234',
            channel_ids: ['<string>'],
            channel_handle: '<string>',
            info_channel: '<string>'
          }
        ],
        avatar: 'https://some.image.url.com/img.jpg',
        custom: {},
        display_name: 'John Smith',
        first: 'John',
        last: 'Smith',
        assignee_id: 42,
        tags: [{tag_id: 1}, {tag_id: 2}],
        is_opted_out: true,
        email_suppressions: [123],
        timezone: 'America/New_York'
      }
    ]
  })
};

fetch('https://api.heymarket.com/v2/contacts', 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/v2/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'contacts' => [
        [
                'contact_channels' => [
                                [
                                                                'channel_type' => 'phone',
                                                                'channel_id' => '14155551234',
                                                                'channel_ids' => [
                                                                                                                                '<string>'
                                                                ],
                                                                'channel_handle' => '<string>',
                                                                'info_channel' => '<string>'
                                ]
                ],
                'avatar' => 'https://some.image.url.com/img.jpg',
                'custom' => [
                                
                ],
                'display_name' => 'John Smith',
                'first' => 'John',
                'last' => 'Smith',
                'assignee_id' => 42,
                'tags' => [
                                [
                                                                'tag_id' => 1
                                ],
                                [
                                                                'tag_id' => 2
                                ]
                ],
                'is_opted_out' => true,
                'email_suppressions' => [
                                123
                ],
                'timezone' => 'America/New_York'
        ]
    ]
  ]),
  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/v2/contacts"

	payload := strings.NewReader("{\n  \"contacts\": [\n    {\n      \"contact_channels\": [\n        {\n          \"channel_type\": \"phone\",\n          \"channel_id\": \"14155551234\",\n          \"channel_ids\": [\n            \"<string>\"\n          ],\n          \"channel_handle\": \"<string>\",\n          \"info_channel\": \"<string>\"\n        }\n      ],\n      \"avatar\": \"https://some.image.url.com/img.jpg\",\n      \"custom\": {},\n      \"display_name\": \"John Smith\",\n      \"first\": \"John\",\n      \"last\": \"Smith\",\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      \"email_suppressions\": [\n        123\n      ],\n      \"timezone\": \"America/New_York\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.heymarket.com/v2/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contacts\": [\n    {\n      \"contact_channels\": [\n        {\n          \"channel_type\": \"phone\",\n          \"channel_id\": \"14155551234\",\n          \"channel_ids\": [\n            \"<string>\"\n          ],\n          \"channel_handle\": \"<string>\",\n          \"info_channel\": \"<string>\"\n        }\n      ],\n      \"avatar\": \"https://some.image.url.com/img.jpg\",\n      \"custom\": {},\n      \"display_name\": \"John Smith\",\n      \"first\": \"John\",\n      \"last\": \"Smith\",\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      \"email_suppressions\": [\n        123\n      ],\n      \"timezone\": \"America/New_York\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.heymarket.com/v2/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contacts\": [\n    {\n      \"contact_channels\": [\n        {\n          \"channel_type\": \"phone\",\n          \"channel_id\": \"14155551234\",\n          \"channel_ids\": [\n            \"<string>\"\n          ],\n          \"channel_handle\": \"<string>\",\n          \"info_channel\": \"<string>\"\n        }\n      ],\n      \"avatar\": \"https://some.image.url.com/img.jpg\",\n      \"custom\": {},\n      \"display_name\": \"John Smith\",\n      \"first\": \"John\",\n      \"last\": \"Smith\",\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      \"email_suppressions\": [\n        123\n      ],\n      \"timezone\": \"America/New_York\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "contacts": [
    {
      "avatar": "<string>",
      "created": "<string>",
      "creator_id": 123,
      "custom": {},
      "display_name": "<string>",
      "email": "<string>",
      "external_id": "<string>",
      "external_ref": "<string>",
      "first": "<string>",
      "id": 123,
      "inbox_id": 123,
      "last": "<string>",
      "note": [
        {
          "date": "<string>",
          "id": "<string>",
          "name": "<string>",
          "text": "<string>",
          "user_id": 123
        }
      ],
      "op": "<string>",
      "parent_id": 123,
      "phone": "<string>",
      "rev": 123,
      "shared": true,
      "team_id": 123,
      "type": "<string>",
      "updated": "<string>",
      "assigned_user_id": 123,
      "tags": [
        "<unknown>"
      ]
    }
  ],
  "failed_contacts": [
    {
      "contact": {
        "contact_channels": [
          {
            "channel_type": "phone",
            "channel_id": "14155551234",
            "channel_ids": [
              "<string>"
            ],
            "channel_handle": "<string>",
            "info_channel": "<string>"
          }
        ],
        "avatar": "https://some.image.url.com/img.jpg",
        "custom": {},
        "display_name": "John Smith",
        "first": "John",
        "last": "Smith",
        "assignee_id": 42,
        "tags": [
          {
            "tag_id": 1
          },
          {
            "tag_id": 2
          }
        ],
        "is_opted_out": true,
        "email_suppressions": [
          123
        ],
        "timezone": "America/New_York"
      },
      "error": "<string>"
    }
  ]
}
"<string>"
"Unauthorized"
"too many requests"
"error"
Use this endpoint for v2 bulk contact imports and updates.

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.

Body

application/json

Bulk contact json

​
contacts
object[]

List of contacts to create or update

Response

Bulk create response

​
contacts
object[]

Successfully created or updated contacts

​
failed_contacts
object[]

Contacts that failed to create or update