Skip to main content
POST
/
api
/
v1
/
impersonation
/
start
Start impersonating a customer by email (Vortex employees only)
curl --request POST \
  --url https://api.example.com/api/v1/impersonation/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetEmail": "[email protected]"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "realMemberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "realMemberEmail": "<string>",
    "impersonatedMemberId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "impersonatedMemberEmail": "<string>",
    "impersonatedAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
targetEmail
string<email>
required

The email address of the customer to impersonate

Example:

"[email protected]"

Response

Impersonation session started successfully

​
data
object
required