Create list

POST

lists

Create List (v2)

curl --request POST \
  --url https://api.heymarket.com/v2/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "contacts": [
    123
  ],
  "phones": [
    "<string>"
  ],
  "emails": [
    "<string>"
  ],
  "local_id": "<string>"
}
'

import requests

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

payload = {
    "title": "<string>",
    "contacts": [123],
    "phones": ["<string>"],
    "emails": ["<string>"],
    "local_id": "<string>"
}
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({
    title: '<string>',
    contacts: [123],
    phones: ['<string>'],
    emails: ['<string>'],
    local_id: '<string>'
  })
};

fetch('https://api.heymarket.com/v2/lists', 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/lists",
  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([
    'title' => '<string>',
    'contacts' => [
        123
    ],
    'phones' => [
        '<string>'
    ],
    'emails' => [
        '<string>'
    ],
    'local_id' => '<string>'
  ]),
  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/lists"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"contacts\": [\n    123\n  ],\n  \"phones\": [\n    \"<string>\"\n  ],\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"local_id\": \"<string>\"\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/lists")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"contacts\": [\n    123\n  ],\n  \"phones\": [\n    \"<string>\"\n  ],\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"local_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"title\": \"<string>\",\n  \"contacts\": [\n    123\n  ],\n  \"phones\": [\n    \"<string>\"\n  ],\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"local_id\": \"<string>\"\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 create a list for broadcast messaging.

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

List json

title

string

required

List name

contacts

integer[]

Array of contact IDs to replace/set the list membership

phones

string[]

Phone numbers in E.164 format (without plus sign) to add as new contacts

emails

string[]

Email addresses to add as new contacts

local_id

string

Client-provided unique identifier for the list

Response

integer

rev

integer

uuid

string

Count lists

Update list

Create List (v2)

curl --request POST \
  --url https://api.heymarket.com/v2/lists \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "contacts": [
    123
  ],
  "phones": [
    "<string>"
  ],
  "emails": [
    "<string>"
  ],
  "local_id": "<string>"
}
'

import requests

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

payload = {
    "title": "<string>",
    "contacts": [123],
    "phones": ["<string>"],
    "emails": ["<string>"],
    "local_id": "<string>"
}
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({
    title: '<string>',
    contacts: [123],
    phones: ['<string>'],
    emails: ['<string>'],
    local_id: '<string>'
  })
};

fetch('https://api.heymarket.com/v2/lists', 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/lists",
  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([
    'title' => '<string>',
    'contacts' => [
        123
    ],
    'phones' => [
        '<string>'
    ],
    'emails' => [
        '<string>'
    ],
    'local_id' => '<string>'
  ]),
  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/lists"

	payload := strings.NewReader("{\n  \"title\": \"<string>\",\n  \"contacts\": [\n    123\n  ],\n  \"phones\": [\n    \"<string>\"\n  ],\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"local_id\": \"<string>\"\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/lists")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"<string>\",\n  \"contacts\": [\n    123\n  ],\n  \"phones\": [\n    \"<string>\"\n  ],\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"local_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"title\": \"<string>\",\n  \"contacts\": [\n    123\n  ],\n  \"phones\": [\n    \"<string>\"\n  ],\n  \"emails\": [\n    \"<string>\"\n  ],\n  \"local_id\": \"<string>\"\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

Body

Response