Reset the sandbox

POST/v1/test/reset

Deletes every member and every order in your sandbox brand, so a test run starts from zero. Your program, locations, rewards, keys and webhook endpoints stay.

Warning A reset can't be undone. Everyone on your team who shares the sandbox brand loses their test members too.

After a reset you can reuse your test external_id and external_order_id values.

Permissions: Sandbox secret key.

Guide

Sandbox

Request headers#

Idempotency-Keystring
Any string up to 255 characters; use a UUID v4. Kept 24 hours per key (or member) and endpoint. Same key and body replays the first response with Idempotent-Replayed: true.
Max Length 255

Response fields#

Returns 200 with object

deleted_membersinteger
deleted_ordersinteger

POST/v1/test/reset

1
2curl -X POST $UNPLUG_API/test/reset \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6
7const response = await fetch(`${process.env.UNPLUG_API}/test/reset`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.post(
    f"{os.environ['UNPLUG_API']}/test/reset",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4{
  "deleted_members": 14,
  "deleted_orders": 37
}

Error descriptions#

404Not found

not_found

Called on production.

Any endpoint can also return the common errors.