Skip to main content
PATCH
Set Simulated Status
Subtotal Connector tool: set_simulated_status Sets one of your simulated connections to active or unauthenticated and sends connection.activated or connection.unauthenticated to webhook destinations that accept simulated events. Use it to test how your integration handles a shopper losing and regaining their retailer login. Setting the status it already has sends the event again. Other statuses return 422. Real connections never change: a real, deleted or unknown connection returns 404. Call it with your API key, or with a Subtotal Connector OAuth token that includes simulator:write. A token without it receives 403 insufficient_scope. Partner app tokens don’t include it.

Headers

authorization
string | null
x-api-key
string | null

Path Parameters

connection_id
string
required

Body

application/json
status
enum<string>
required

unauthenticated emits connection.unauthenticated, as when a consumer's retailer login expires; active emits connection.activated, as when they reconnect

Available options:
active,
unauthenticated
Example:

"unauthenticated"

Response

Successful Response

connection_id
string
required

A unique identifier for the connection

Example:

"01J51S0JYV6N7K1030CV1ZKSCA"

customer_id
string
required

A unique identifier used to map connections to customer records in external systems.

Example:

"8a46e581-48ba-498a-9ad0-2ee72582e1af"

retailer_id
string
required

The unique identifier for the retailer in the connection

Example:

"01J7SC0NN73R6F5VVSP3ZKPDA3"

status
enum<string>
required

The status of the connection

Available options:
active,
initialized,
unauthenticated,
disconnected
Example:

"active"

email
string | null
required

The customer's email address

Example:

"alice@example.com"

mobile
string | null
required

The customer's mobile phone number

Example:

"+1234567890"

creation_date
string<date-time>
required

When the connection was created

Example:

"2024-08-13T17:27:57.913Z"

tags
Tags · object

Client-defined attribution tags recorded when the connection is created, for grouping connection metrics — e.g. {"campaign": "summer_sweeps", "program": "loyalty"}. Names and values are opaque to Subtotal and are never interpreted. At most 10 tags; names up to 64 characters, values up to 256. Intended for campaign and source metadata — do not put consumer PII in tags.

Example:
is_simulated
boolean
default:false

True for a test connection made with the event simulator. Its events are marked is_simulated too, and it never collects real purchases.

Example:

false