Create guest user

Create guest user

Authorizations

x-api-key

string

headerrequired

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

Request body for creating a guest user

user

object

User details

Show child attributes

provider

object

Show child attributes

Response

200 - application/json

Sign-in response body

_id

string

Response ID

userId

string

User ID

roles

string[]

User roles

name

object

User's full name

Show child attributes

account

string

Merchant account ID

userType

string

Type of user

accessToken

string

Access token

refreshToken

string

Refresh token