Bulk toggle a user’s subscription states

curl --request PATCH \
  --url https://apix.spotzee.com/api/client/users/{userId}/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "subscription_id": 7,
    "state": 1
  }
]
'

import requests

url = "https://apix.spotzee.com/api/client/users/{userId}/subscriptions"

payload = [
    {
        "subscription_id": 7,
        "state": 1
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{subscription_id: 7, state: 1}])
};

fetch('https://apix.spotzee.com/api/client/users/{userId}/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/client/users/{userId}/subscriptions"

	payload := strings.NewReader("[\n  {\n    \"subscription_id\": 7,\n    \"state\": 1\n  }\n]")

	req, _ := http.NewRequest("PATCH", 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))

}

{
  "id": 1024,
  "project_id": 42,
  "external_id": "cust-9f4b21",
  "created_at": "2026-04-28T05:14:00.000Z",
  "updated_at": "2026-04-28T05:14:00.000Z",
  "anonymous_id": "anon-2c8a3e",
  "email": "jane@example.com",
  "phone": "+61400123456",
  "timezone": "Australia/Sydney",
  "locale": "en-AU",
  "data": {
    "first_name": "Jane",
    "last_name": "Doe",
    "plan": "pro"
  },
  "has_push_device": true,
  "devices": [
    {}
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

Subscriptions

Bulk toggle a user’s subscription states

Subscribes or unsubscribes a user across one or more subscription types in a single call. Up to 100 toggles per request. Toggling to the current state is a no-op (idempotent). The response is the refreshed user record so callers can confirm the update without a second round-trip.

Idempotent — pass an Idempotency-Key header to make safely retryable. On a replay the original response is returned with Idempotent-Replayed: true. See the API conventions guide for the full state machine, TTL, and mismatch behaviour.

PATCH

users

{userId}

subscriptions

Bulk toggle a user’s subscription states

curl --request PATCH \
  --url https://apix.spotzee.com/api/client/users/{userId}/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "subscription_id": 7,
    "state": 1
  }
]
'

import requests

url = "https://apix.spotzee.com/api/client/users/{userId}/subscriptions"

payload = [
    {
        "subscription_id": 7,
        "state": 1
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([{subscription_id: 7, state: 1}])
};

fetch('https://apix.spotzee.com/api/client/users/{userId}/subscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/client/users/{userId}/subscriptions"

	payload := strings.NewReader("[\n  {\n    \"subscription_id\": 7,\n    \"state\": 1\n  }\n]")

	req, _ := http.NewRequest("PATCH", 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))

}

{
  "id": 1024,
  "project_id": 42,
  "external_id": "cust-9f4b21",
  "created_at": "2026-04-28T05:14:00.000Z",
  "updated_at": "2026-04-28T05:14:00.000Z",
  "anonymous_id": "anon-2c8a3e",
  "email": "jane@example.com",
  "phone": "+61400123456",
  "timezone": "Australia/Sydney",
  "locale": "en-AU",
  "data": {
    "first_name": "Jane",
    "last_name": "Doe",
    "plan": "pro"
  },
  "has_push_device": true,
  "devices": [
    {}
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

Authorizations

Authorization

string

header

required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Path Parameters

userId

string

required

Numeric ID (admin scope) or user external_id (project scope) — the route resolves both.

Example:

"cust-9f4b21"

Body

application/json

Required array length: 1 - 100 elements

subscription_id

integer

required

Numeric subscription-type identifier to toggle.

Example:

7

state

required

Subscription state: 0 unsubscribed, 1 subscribed, 2 explicit double-opt-in. Reads return the current state; writes accept any of the three values to set it.

Available options:

0

Example:

1

Response

The user, refreshed after the toggle.

A customer record being marketed to. Owned by a project; identified by external_id.

integer

required

Numeric identifier. Use external_id as the stable cross-system reference.

Example:

1024

project_id

integer

required

Identifier of the project this user belongs to.

Example:

42

external_id

string

required

Stable identifier supplied by the calling system. Treated as the user’s primary key for upserts.

Example:

"cust-9f4b21"

created_at

string | null

required

Time the user was first created. ISO 8601.

Example:

"2026-04-28T05:14:00.000Z"

updated_at

string | null

required

Time the user was last modified. ISO 8601.

Example:

"2026-04-28T05:14:00.000Z"

anonymous_id

string | null

Anonymous tracking identifier captured before the user was identified, when available.

Example:

"anon-2c8a3e"

string | null

User’s email address. Format-validated on write.

Example:

"jane@example.com"

phone

string | null

User’s phone number in E.164 format on read.

Example:

"+61400123456"

timezone

string | null

IANA timezone used for time-of-day delivery scheduling.

Example:

"Australia/Sydney"

locale

string | null

BCP-47 locale used for content rendering.

Example:

"en-AU"

data

object

Free-form custom attributes attached to the user. Used in segmentation and template rendering.

Example:

{
  "first_name": "Jane",
  "last_name": "Doe",
  "plan": "pro"
}

has_push_device

boolean

True when the user has at least one registered push device.

devices

object[]

Registered push devices, when included.

Overview

Projects

Events

Campaigns

Lists

Subscriptions

Journeys

Templates

Users

Tags

API keys

Organisation

Billing recovery

Webhooks

CRM

Source Sync

Form definitions

Form submissions

Bulk toggle a user’s subscription states

Authorizations

Path Parameters

Body

Response