Skip to main content
PUT
/
v1
/
schedule
/
{id}
Schedule update
curl --request PUT \
  --url https://api.heymarket.com/v1/schedule/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "_": 123,
  "content": {
    "attachments": [
      {
        "name": "<string>",
        "type": "<string>",
        "url": "<string>"
      }
    ],
    "gallery": [
      {
        "annotation_position": "<string>",
        "annotation_text": "<string>",
        "original_url": "<string>",
        "url": "<string>"
      }
    ],
    "local_day": 123,
    "local_time": "<string>",
    "offset": 123,
    "template": 123,
    "text": "<string>",
    "to": "<string>"
  },
  "conversation_id": 123,
  "execute_at": "<string>",
  "inbox_id": 123,
  "is_email": true,
  "list_id": 123,
  "local_id": "<string>",
  "phone_number": "<string>",
  "super_id": 123,
  "targets": [
    "<string>"
  ],
  "user_id": 123
}
'
import requests

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

payload = {
    "_": 123,
    "content": {
        "attachments": [
            {
                "name": "<string>",
                "type": "<string>",
                "url": "<string>"
            }
        ],
        "gallery": [
            {
                "annotation_position": "<string>",
                "annotation_text": "<string>",
                "original_url": "<string>",
                "url": "<string>"
            }
        ],
        "local_day": 123,
        "local_time": "<string>",
        "offset": 123,
        "template": 123,
        "text": "<string>",
        "to": "<string>"
    },
    "conversation_id": 123,
    "execute_at": "<string>",
    "inbox_id": 123,
    "is_email": True,
    "list_id": 123,
    "local_id": "<string>",
    "phone_number": "<string>",
    "super_id": 123,
    "targets": ["<string>"],
    "user_id": 123
}
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({
    _: 123,
    content: {
      attachments: [{name: '<string>', type: '<string>', url: '<string>'}],
      gallery: [
        {
          annotation_position: '<string>',
          annotation_text: '<string>',
          original_url: '<string>',
          url: '<string>'
        }
      ],
      local_day: 123,
      local_time: '<string>',
      offset: 123,
      template: 123,
      text: '<string>',
      to: '<string>'
    },
    conversation_id: 123,
    execute_at: '<string>',
    inbox_id: 123,
    is_email: true,
    list_id: 123,
    local_id: '<string>',
    phone_number: '<string>',
    super_id: 123,
    targets: ['<string>'],
    user_id: 123
  })
};

fetch('https://api.heymarket.com/v1/schedule/{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/schedule/{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([
    '_' => 123,
    'content' => [
        'attachments' => [
                [
                                'name' => '<string>',
                                'type' => '<string>',
                                'url' => '<string>'
                ]
        ],
        'gallery' => [
                [
                                'annotation_position' => '<string>',
                                'annotation_text' => '<string>',
                                'original_url' => '<string>',
                                'url' => '<string>'
                ]
        ],
        'local_day' => 123,
        'local_time' => '<string>',
        'offset' => 123,
        'template' => 123,
        'text' => '<string>',
        'to' => '<string>'
    ],
    'conversation_id' => 123,
    'execute_at' => '<string>',
    'inbox_id' => 123,
    'is_email' => true,
    'list_id' => 123,
    'local_id' => '<string>',
    'phone_number' => '<string>',
    'super_id' => 123,
    'targets' => [
        '<string>'
    ],
    'user_id' => 123
  ]),
  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/schedule/{id}"

	payload := strings.NewReader("{\n  \"_\": 123,\n  \"content\": {\n    \"attachments\": [\n      {\n        \"name\": \"<string>\",\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"gallery\": [\n      {\n        \"annotation_position\": \"<string>\",\n        \"annotation_text\": \"<string>\",\n        \"original_url\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"local_day\": 123,\n    \"local_time\": \"<string>\",\n    \"offset\": 123,\n    \"template\": 123,\n    \"text\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"conversation_id\": 123,\n  \"execute_at\": \"<string>\",\n  \"inbox_id\": 123,\n  \"is_email\": true,\n  \"list_id\": 123,\n  \"local_id\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"super_id\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"user_id\": 123\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/schedule/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"_\": 123,\n  \"content\": {\n    \"attachments\": [\n      {\n        \"name\": \"<string>\",\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"gallery\": [\n      {\n        \"annotation_position\": \"<string>\",\n        \"annotation_text\": \"<string>\",\n        \"original_url\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"local_day\": 123,\n    \"local_time\": \"<string>\",\n    \"offset\": 123,\n    \"template\": 123,\n    \"text\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"conversation_id\": 123,\n  \"execute_at\": \"<string>\",\n  \"inbox_id\": 123,\n  \"is_email\": true,\n  \"list_id\": 123,\n  \"local_id\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"super_id\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"user_id\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.heymarket.com/v1/schedule/{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  \"_\": 123,\n  \"content\": {\n    \"attachments\": [\n      {\n        \"name\": \"<string>\",\n        \"type\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"gallery\": [\n      {\n        \"annotation_position\": \"<string>\",\n        \"annotation_text\": \"<string>\",\n        \"original_url\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"local_day\": 123,\n    \"local_time\": \"<string>\",\n    \"offset\": 123,\n    \"template\": 123,\n    \"text\": \"<string>\",\n    \"to\": \"<string>\"\n  },\n  \"conversation_id\": 123,\n  \"execute_at\": \"<string>\",\n  \"inbox_id\": 123,\n  \"is_email\": true,\n  \"list_id\": 123,\n  \"local_id\": \"<string>\",\n  \"phone_number\": \"<string>\",\n  \"super_id\": 123,\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"user_id\": 123\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 change a scheduled message before it sends.

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

​
id
integer
required

Schedule ID

Body

application/json

Schedule json

​
_
integer
​
content
object
​
conversation_id
integer
​
execute_at
string
​
inbox_id
integer
​
is_email
boolean
​
list_id
integer
​
local_id
string
​
phone_number
string
​
super_id
integer
​
targets
string[]
​
user_id
integer

Response

OK

​
id
integer
​
rev
integer
​
uuid
string