Get contact status
Get a contact’s messaging status.
curl --request POST \
--url https://api.heymarket.com/v1/contact/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": 10000,
"phone": "12345678900"
}
'import requests
url = "https://api.heymarket.com/v1/contact/status"
payload = {
"id": 10000,
"phone": "12345678900"
}
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({id: 10000, phone: '12345678900'})
};
fetch('https://api.heymarket.com/v1/contact/status', 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/status",
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([
'id' => 10000,
'phone' => '12345678900'
]),
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/status"
payload := strings.NewReader("{\n \"id\": 10000,\n \"phone\": \"12345678900\"\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/v1/contact/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 10000,\n \"phone\": \"12345678900\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/contact/status")
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 \"id\": 10000,\n \"phone\": \"12345678900\"\n}"
response = http.request(request)
puts response.read_body{
"id": 10000,
"phone": "12345678900",
"unsubscribed": false,
"unsubscribed_contact": false,
"unsubscribed_admin": false,
"blocked": false,
"inbox_opt_outs": [
{
"inbox_id": 2,
"set_from_contact": false
}
],
"global_opt_out": false
}"<string>"Unauthorizedtoo many requestserrorAuthorizations
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
Heymarket ID of the contact
Response
Status of the contact
10000
"12345678900"
false
false
false
false
Inboxes this contact is opted out of via inbox-scoped opt-outs. Only present when the number has inbox-scoped opt-out rows; omitted otherwise and for global (team-wide) opt-outs. The unsubscribed, unsubscribed_contact, and unsubscribed_admin booleans above keep their existing any-row semantics and are unaffected by this field.
Show child attributes
Show child attributes
True when the number has a team-wide (non-inbox-scoped) opt-out row, independent of inbox_opt_outs. Always present, including when false. The two kinds coexist: with this true, the contact is blocked on every inbox, including inboxes absent from inbox_opt_outs — read both fields before treating an inbox as sendable.
false
Was this page helpful?
curl --request POST \
--url https://api.heymarket.com/v1/contact/status \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": 10000,
"phone": "12345678900"
}
'import requests
url = "https://api.heymarket.com/v1/contact/status"
payload = {
"id": 10000,
"phone": "12345678900"
}
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({id: 10000, phone: '12345678900'})
};
fetch('https://api.heymarket.com/v1/contact/status', 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/status",
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([
'id' => 10000,
'phone' => '12345678900'
]),
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/status"
payload := strings.NewReader("{\n \"id\": 10000,\n \"phone\": \"12345678900\"\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/v1/contact/status")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": 10000,\n \"phone\": \"12345678900\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.heymarket.com/v1/contact/status")
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 \"id\": 10000,\n \"phone\": \"12345678900\"\n}"
response = http.request(request)
puts response.read_body{
"id": 10000,
"phone": "12345678900",
"unsubscribed": false,
"unsubscribed_contact": false,
"unsubscribed_admin": false,
"blocked": false,
"inbox_opt_outs": [
{
"inbox_id": 2,
"set_from_contact": false
}
],
"global_opt_out": false
}"<string>"Unauthorizedtoo many requestserror