v2.84.0

TS Dev 108 API Documentation

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

---

ConnectJobs

Endpoints to interact with connectJobs

Operations

GET/api/v2/connect-jobsPOST/api/v2/connect-jobsGET/api/v2/connect-jobs/{id}DELETE/api/v2/connect-jobs/{id}PATCH/api/v2/connect-jobs/{id}GET/api/v2/connect-jobs/{id}/recipientsPOST/api/v2/connect-jobs/{id}/startGET/api/v2/connectJob/{id}DELETE/api/v2/connectJob/{id}PATCH/api/v2/connectJob/{id}GET/api/v2/connectJobPOST/api/v2/connectJobGET/api/v2/connectJob/{id}/members

---

List connect jobs

GET

/api/v2/connect-jobs

Paginated jobs for the authenticated organizer scope. Optional eventId filters by event.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

eventId

Type

integer

Responses

Connect job list

Content-Type

application/json

{

  

"count": 10,

  

"totalCount": 25,

  

"limit": 50,

  

"offset": 25,

  

"data": [

  

]

}

GET

/api/v2/connect-jobs

Playground

Authorization

bearerAuth

Variables

Key

Value

eventId

Samples

---

Create connect job

POST

/api/v2/connect-jobs

Creates a job and recipient rows. Barcodes apply only to email blast + upload-list target. waveTimeIds is validated only when the site wave-time tab participant setting is enabled.

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

Created

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/connect-jobs

Playground

Authorization

bearerAuth

Body

Samples

---

Get connect job by id

GET

/api/v2/connect-jobs/{id}

Returns a single formatted job (ConnectJobFormatter).

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Connect job

Content-Type

application/json

{

  

"data": "string"

}

GET

/api/v2/connect-jobs/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete connect job (soft delete)

DELETE

/api/v2/connect-jobs/{id}

Soft delete job log (same as v1 apiJobDelete). Recipient rows are not removed.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Job deleted

DELETE

/api/v2/connect-jobs/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update connect job

PATCH

/api/v2/connect-jobs/{id}

Updates schedule (startTime), disabled flag, and/or Connect email template. Unknown JSON keys are rejected (strict validation).

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Request Body

application/json

"string"

Responses

Updated job

Content-Type

application/json

{

  

"data": "string"

}

PATCH

/api/v2/connect-jobs/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

List recipients for a connect job

GET

/api/v2/connect-jobs/{id}/recipients

Paginated recipient rows for the job; optional status filters by recipient status.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Query Parameters

status

Type

string

Valid values

"completed""queued""failed"

Responses

Paginated recipients (ConnectRecipientFormatter: status as lowercase string, orderId from objectId)

Content-Type

application/json

"string"

GET

/api/v2/connect-jobs/{id}/recipients

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

status

Samples

---

Start connect job run (legacy runner, asynchronous)

POST

/api/v2/connect-jobs/{id}/start

Dispatches the same admin connect runJob URL used by cron; returns immediately while sending continues in the background.

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

Type

integer

Required

Responses

Run triggered; poll job/recipients for progress

Content-Type

application/json

{

  

"data": "string"

}

POST

/api/v2/connect-jobs/{id}/start

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Find ConnectJob by Id

GET

/api/v2/connectJob/{id}

Returns a single ConnectJob

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/connectJob/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Delete one ConnectJob by Id

DELETE

/api/v2/connectJob/{id}

Deletes the identified ConnectJob

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Responses

DELETE

/api/v2/connectJob/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Update ConnectJob by Id

PATCH

/api/v2/connectJob/{id}

Updates an existing ConnectJob from the PATCH data

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Request Body

application/json

{

  

"data": "string"

}

Responses

PATCH

/api/v2/connectJob/{id}

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Body

Samples

---

Find a list of ConnectJobs by a set of filters

GET

/api/v2/connectJob

Returns a list of ConnectJobs

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Query Parameters

_limit

Set the max number of objects to return

Type

number

Format

"int64"

_offset

Set the number of objects to ignore before starting

Type

number

Format

"int64"

_search

text string that will search certain text fields

Type

string

_select

comma separated list of items to select ('connectJobs.*, event.name')

Type

string

eventId

eventId

Type

integer

Format

"int64"

name

Name of Connect Job

Type

string

subject

subject

Type

string

submitTime

Time submitted

Type

integer

Format

"int64"

type

ConnectJob Type Id

Type

string

Responses

GET

/api/v2/connectJob

Playground

Authorization

bearerAuth

Variables

Key

Value

_limit

_offset

_search

_select

eventId

name

subject

submitTime

type

Samples

---

Create ConnectJob

POST

/api/v2/connectJob

Creates a new ConnectJob from the POST data

Authorizations

bearerAuth

Type

HTTP (bearer)

Request Body

application/json

"string"

Responses

POST

/api/v2/connectJob

Playground

Authorization

bearerAuth

Body

Samples

---

Find ConnectJob Members by Id

GET

/api/v2/connectJob/{id}/members

Returns a a list of members

Authorizations

bearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

id*

id

Type

integer

Required

Format

"int64"

Responses

GET

/api/v2/connectJob/{id}/members

Playground

Authorization

bearerAuth

Variables

Key

Value

id*

Samples

---

Powered by VitePress OpenAPI