v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

Unregistered Customers

Endpoints to interact with unregistered customers

Operations

GET/api/v2/unregistered-customersGET/api/v2/unregistered-customers/{id}DELETE/api/v2/unregistered-customers/{id}POST/api/v2/unregistered-customers/bulk-deletePOST/api/v2/unregistered-customers/send-emailPOST/api/v2/unregistered-customers/send-email-preview

---

Get a list of unregistered customers

GET

/api/v2/unregistered-customers

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_include

Include related resources (unpurchased). Note: unpurchasedCount is always included.

Type

string

Responses

Unregistered customer list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/unregistered-customers

Playground

Authorization

bearerAuth

Variables

Key

Value

_include

Samples

---

Get an unregistered customer by ID

GET

/api/v2/unregistered-customers/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of unregistered customer to return

Type

integer

Required

Format

"int64"

Query Parameters

_include

Include related resources (unpurchased). Note: unpurchasedCount is always included.

Type

string

Responses

Unregistered customer object

Content-Type

application/json

"string"

GET

/api/v2/unregistered-customers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

_include

Samples

---

Delete an unregistered customer

DELETE

/api/v2/unregistered-customers/{id}

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

ID of unregistered customer to delete

Type

integer

Required

Format

"int64"

Responses

Unregistered customer deleted successfully

DELETE

/api/v2/unregistered-customers/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Bulk delete unregistered customers

POST

/api/v2/unregistered-customers/bulk-delete

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"ids": [

  

  

0

  

]

}

Responses

Unregistered customers deleted successfully

POST

/api/v2/unregistered-customers/bulk-delete

Playground

Authorization

bearerAuth

Body

Samples

---

Send email to unregistered customers

POST

/api/v2/unregistered-customers/send-email

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"timeLimit": 5,

  

"eventFilter": 0

}

Responses

Success message

Content-Type

application/json

{

  

"success": true,

  

"message": "Emails sent successfully."

}

POST

/api/v2/unregistered-customers/send-email

Playground

Authorization

bearerAuth

Body

Samples

---

Get preview of email count that will be sent

POST

/api/v2/unregistered-customers/send-email-preview

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

{

  

"timeLimit": 5,

  

"eventFilter": 0

}

Responses

Preview count

Content-Type

application/json

{

  

"count": 10

}

POST

/api/v2/unregistered-customers/send-email-preview

Playground

Authorization

bearerAuth

Body

Samples

---

Powered by VitePress OpenAPI