Start a Live Activity

POST

api

push

live-activities

start

Start a Live Activity

curl --request POST \
  --url https://api.sequenzy.com/api/v1/push/live-activities/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "subscriberId": "<string>",
  "activityType": "<string>",
  "activityId": "<string>",
  "attributes": {},
  "contentState": {},
  "alert": {},
  "staleDate": {},
  "relevanceScore": 123
}
'

import requests

url = "https://api.sequenzy.com/api/v1/push/live-activities/start"

payload = {
    "email": "<string>",
    "subscriberId": "<string>",
    "activityType": "<string>",
    "activityId": "<string>",
    "attributes": {},
    "contentState": {},
    "alert": {},
    "staleDate": {},
    "relevanceScore": 123
}
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({
    email: '<string>',
    subscriberId: '<string>',
    activityType: '<string>',
    activityId: '<string>',
    attributes: {},
    contentState: {},
    alert: {},
    staleDate: {},
    relevanceScore: 123
  })
};

fetch('https://api.sequenzy.com/api/v1/push/live-activities/start', 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.sequenzy.com/api/v1/push/live-activities/start",
  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([
    'email' => '<string>',
    'subscriberId' => '<string>',
    'activityType' => '<string>',
    'activityId' => '<string>',
    'attributes' => [
        
    ],
    'contentState' => [
        
    ],
    'alert' => [
        
    ],
    'staleDate' => [
        
    ],
    'relevanceScore' => 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.sequenzy.com/api/v1/push/live-activities/start"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"subscriberId\": \"<string>\",\n  \"activityType\": \"<string>\",\n  \"activityId\": \"<string>\",\n  \"attributes\": {},\n  \"contentState\": {},\n  \"alert\": {},\n  \"staleDate\": {},\n  \"relevanceScore\": 123\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.sequenzy.com/api/v1/push/live-activities/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"subscriberId\": \"<string>\",\n  \"activityType\": \"<string>\",\n  \"activityId\": \"<string>\",\n  \"attributes\": {},\n  \"contentState\": {},\n  \"alert\": {},\n  \"staleDate\": {},\n  \"relevanceScore\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/push/live-activities/start")

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  \"email\": \"<string>\",\n  \"subscriberId\": \"<string>\",\n  \"activityType\": \"<string>\",\n  \"activityId\": \"<string>\",\n  \"attributes\": {},\n  \"contentState\": {},\n  \"alert\": {},\n  \"staleDate\": {},\n  \"relevanceScore\": 123\n}"

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

{
  "success": true,
  "event": "start",
  "activityId": "order-1234",
  "tokenCount": 1,
  "jobIds": ["liveact-6c1f-0"],
  "message": "Start queued for 1 device."
}

{
  "error": "Live Activities are delivered through APNs. Add your APNs key in push settings first."
}

{
  "error": "Invalid API key"
}

{ "success": false, "error": "Expected property 'contentState' to be object" }

{
  "error": "API key is missing required scope: transactional:send"
}

{
  "error": "Subscriber not found."
}

Starts a Live Activity with push-to-start (iOS 17.2+) on every device of one contact that reported a push-to-start token for activityType. Your app reports these tokens once it calls Sequenzy.observeLiveActivities(of:) (see Live Activities). Requires the transactional:send scope and APNs credentials in push settings. Sequenzy adds sequenzy: { "activityId": "..." } to the attributes. The SDK reads it to report the new activity’s update token under your activityId, which update and end use. The request returns 202 once delivery is queued. When no device can start the activity, it still returns 202 with tokenCount: 0 and sends nothing, so you can fall back to a regular push. Calling start again starts another copy on the same devices; update the running one instead.

Request

string

Contact whose devices start the activity. Provide email or subscriberId.

string

Subscriber whose devices start the activity.

string

required

Your Swift ActivityAttributes type name exactly, such as DeliveryAttributes. APNs receives it as attributes-type.

string

required

Your id for this activity, such as order-1234: 1 to 128 letters, digits, ., :, - or _, starting with a letter or digit. Use one id per person’s activity.

object

default:"{}"

Static attributes as JSON, decoded into your attributes struct. A sequenzy key you send is replaced.

object

required

Your ContentState as JSON. Date fields decode as seconds since 2001-01-01, not Unix time, unless your struct decodes them differently.

object

required

Apple requires an alert to start an activity: title and/or body, plus an optional sound such as default.

integer | string

When iOS shows the activity as out of date: Unix seconds or an ISO 8601 date.

number

Orders a person’s concurrent activities; higher shows first. 0 to 1,000,000.

The whole APNs payload must fit in 4 KB, or the request fails with 400.

curl -X POST "https://api.sequenzy.com/api/v1/push/live-activities/start" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "email": "jane@example.com",
    "activityType": "DeliveryAttributes",
    "activityId": "order-1234",
    "attributes": { "orderNumber": "1234" },
    "contentState": { "status": "preparing", "minutesAway": 30 },
    "alert": { "title": "Order confirmed", "body": "We are preparing it now." }
  }'

Responses

A body with a missing or mistyped field is rejected with 422 before any other check; invalid ids, dates and the missing contact return 400.

{
  "success": true,
  "event": "start",
  "activityId": "order-1234",
  "tokenCount": 1,
  "jobIds": ["liveact-6c1f-0"],
  "message": "Start queued for 1 device."
}

{
  "error": "Live Activities are delivered through APNs. Add your APNs key in push settings first."
}

{
  "error": "Invalid API key"
}

{ "success": false, "error": "Expected property 'contentState' to be object" }

{
  "error": "API key is missing required scope: transactional:send"
}

{
  "error": "Subscriber not found."
}

Start a Live Activity

curl --request POST \
  --url https://api.sequenzy.com/api/v1/push/live-activities/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "subscriberId": "<string>",
  "activityType": "<string>",
  "activityId": "<string>",
  "attributes": {},
  "contentState": {},
  "alert": {},
  "staleDate": {},
  "relevanceScore": 123
}
'

import requests

url = "https://api.sequenzy.com/api/v1/push/live-activities/start"

payload = {
    "email": "<string>",
    "subscriberId": "<string>",
    "activityType": "<string>",
    "activityId": "<string>",
    "attributes": {},
    "contentState": {},
    "alert": {},
    "staleDate": {},
    "relevanceScore": 123
}
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({
    email: '<string>',
    subscriberId: '<string>',
    activityType: '<string>',
    activityId: '<string>',
    attributes: {},
    contentState: {},
    alert: {},
    staleDate: {},
    relevanceScore: 123
  })
};

fetch('https://api.sequenzy.com/api/v1/push/live-activities/start', 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.sequenzy.com/api/v1/push/live-activities/start",
  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([
    'email' => '<string>',
    'subscriberId' => '<string>',
    'activityType' => '<string>',
    'activityId' => '<string>',
    'attributes' => [
        
    ],
    'contentState' => [
        
    ],
    'alert' => [
        
    ],
    'staleDate' => [
        
    ],
    'relevanceScore' => 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.sequenzy.com/api/v1/push/live-activities/start"

	payload := strings.NewReader("{\n  \"email\": \"<string>\",\n  \"subscriberId\": \"<string>\",\n  \"activityType\": \"<string>\",\n  \"activityId\": \"<string>\",\n  \"attributes\": {},\n  \"contentState\": {},\n  \"alert\": {},\n  \"staleDate\": {},\n  \"relevanceScore\": 123\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.sequenzy.com/api/v1/push/live-activities/start")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"<string>\",\n  \"subscriberId\": \"<string>\",\n  \"activityType\": \"<string>\",\n  \"activityId\": \"<string>\",\n  \"attributes\": {},\n  \"contentState\": {},\n  \"alert\": {},\n  \"staleDate\": {},\n  \"relevanceScore\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/push/live-activities/start")

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  \"email\": \"<string>\",\n  \"subscriberId\": \"<string>\",\n  \"activityType\": \"<string>\",\n  \"activityId\": \"<string>\",\n  \"attributes\": {},\n  \"contentState\": {},\n  \"alert\": {},\n  \"staleDate\": {},\n  \"relevanceScore\": 123\n}"

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

{
  "success": true,
  "event": "start",
  "activityId": "order-1234",
  "tokenCount": 1,
  "jobIds": ["liveact-6c1f-0"],
  "message": "Start queued for 1 device."
}

{
  "error": "Live Activities are delivered through APNs. Add your APNs key in push settings first."
}

{
  "error": "Invalid API key"
}

{ "success": false, "error": "Expected property 'contentState' to be object" }

{
  "error": "API key is missing required scope: transactional:send"
}

{
  "error": "Subscriber not found."
}

​Request

​Responses

Request

Responses