Skip to main content
POST
/
api
/
user-snapshots
/
{id}
/
apply
Apply a user snapshot
curl --request POST \
  --url https://your-instance.example.com/api/user-snapshots/{id}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipelineMapping": {
    "Move to Contacted on first reply": {
      "Contacted": "Reached Out"
    }
  },
  "agentMapping": {},
  "applyAutomations": true,
  "applyPrompts": true,
  "applyTemplates": true,
  "newUser": {
    "email": "casey@acme.example",
    "password": "TempPass!2026",
    "fullName": "Casey New",
    "accessRole": "SALES_REP"
  }
}
'
{
  "message": "Snapshot applied",
  "result": {
    "userId": "64ee9a8b1e7f2a001122339c",
    "userEmail": "casey@acme.example",
    "cloned": {
      "automations": 5,
      "prompts": 8,
      "templates": 12
    },
    "mapped": {
      "prompts": 0
    },
    "skipped": {
      "automations": 0,
      "templates": 0
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
newUser
object
required
Example:
{
  "email": "casey@acme.example",
  "password": "TempPass!2026",
  "fullName": "Casey New",
  "phoneNumber": "+14155550177",
  "designation": "Account Executive",
  "accessRole": "SALES_REP"
}
​
pipelineMapping
object

Per-automation map of source pipeline stage value → target stage value.

​
sourceStatusesMapping
object

Per-automation override for sourceStatuses array (mapped target stages).

​
agentMapping
object

Per-automation map of source agent name/id → target agent _id.

​
selectedPromptNames
string[]

Same-org apply only: subset of snapshot prompt names to clone.

​
applyAutomations
boolean
default:true
​
applyPrompts
boolean
default:true
​
applyTemplates
boolean
default:true

Response

Snapshot applied – new user created

​
message
string
​
result
object