Paths

Create an opt-out list

POST /optout/lists

Description

Returns the created opt-out list.

Parameters

Type Name Description Schema

Body

body
optional

An object containing the values required to create opt-out list. The property projectId is optional and if not specified, the company level opt-out list will be created.

CreateOptOutList

Responses

HTTP Code Description Schema

200

OK

OptOutList

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Produces

  • application/json

Tags

  • OptOutList

Example HTTP request

Request body

{
  "projectId" : "p123456789"
}

Example HTTP response

Response 200

{
  "id" : 1,
  "companyId" : 1,
  "projectId" : "p123456789"
}

Get an opt-out list

GET /optout/lists

Description

Returns the company level or project level opt-out list.

Parameters

Type Name Description Schema

Query

projectId
optional

Optional parameter to get the opt-out list for the specified project.

string

Responses

HTTP Code Description Schema

200

OK

OptOutList

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • OptOutList

Example HTTP response

Response 200

{
  "id" : 1,
  "companyId" : 1,
  "projectId" : "p123456789"
}

Add a domain

POST /optout/lists/{optOutListId}/domains

Description

Adds a domain to the opt-out list.

Parameters

Type Name Description Schema

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Body

body
optional

An object containing the values required to add a domain.

CreateBlacklistedDomain

Responses

HTTP Code Description Schema

200

OK

integer (int32)

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Produces

  • application/json

Tags

  • BlacklistedDomains

Example HTTP request

Request body

{
  "domain" : "example.com"
}

Get all domains

GET /optout/lists/{optOutListId}/domains

Description

Returns the list of all domains in the opt-out list.

Parameters

Type Name Description Schema Default

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Query

$filterValue
optional

Value to filter list of blacklisted domains

string

Query

$orderAscending
optional

boolean

"true"

Query

$orderBy
optional

Ordering list by blacklisted domain properties

string

"Domain"

Query

$page
optional

Page number

integer (int32)

1

Query

$pageSize
optional

Page size

integer (int32)

100

Responses

HTTP Code Description Schema

200

OK

PaginationResponse[BlacklistedDomain]

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • BlacklistedDomains

Example HTTP response

Response 200

{
  "totalCount" : 1,
  "items" : [ {
    "id" : 1,
    "domain" : "test@example.com",
    "timestamp" : "2025-01-22T09:09:13.9123932Z"
  } ]
}

Export all domains

GET /optout/lists/{optOutListId}/domains/export

Description

Returns all domains as .csv file

Parameters

Type Name Description Schema

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Responses

HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • BlacklistedDomains

Import domains

POST /optout/lists/{optOutListId}/domains/import

Description

Import domains from .csv, .xlsx or .txt

Parameters

Type Name Description Schema

Path

optOutListId
required

The id of the opt-out list

integer (int64)

FormData

file
optional

File containing list of domains to import

file

Responses

HTTP Code Description Schema

200

OK

ImportResult

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • BlacklistedDomains

Example HTTP response

Response 200

{
  "newRows" : 1,
  "duplicatedRows" : 0,
  "invalidRows" : 0
}

Delete a domain

DELETE /optout/lists/{optOutListId}/domains/{domainId}

Description

Deletes a domain from the opt-out list.

Parameters

Type Name Description Schema

Path

domainId
required

The id of the domain

integer (int64)

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Responses

HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • BlacklistedDomains

Add an email

POST /optout/lists/{optOutListId}/emails

Description

Adds an email to the opt-out list.

Parameters

Type Name Description Schema

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Body

body
optional

The object containing the values required to add an email.

CreateBlacklistedEmail

Responses

HTTP Code Description Schema

200

OK

integer (int32)

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Consumes

  • application/json-patch+json

  • application/json

  • text/json

  • application/*+json

Produces

  • application/json

Tags

  • BlacklistedEmails

Example HTTP request

Request body

{
  "emailAddress" : "test@example.com"
}

Get all emails

GET /optout/lists/{optOutListId}/emails

Description

Returns the list of all emails in the opt-out list.

Parameters

Type Name Description Schema Default

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Query

$filterValue
optional

Filtering list by blacklisted email address

string

Query

$orderAscending
optional

boolean

"true"

Query

$orderBy
optional

Ordering list by blacklisted email properties

string

"EmailAddress"

Query

$page
optional

Page number

integer (int32)

1

Query

$pageSize
optional

Page size

integer (int32)

100

Responses

HTTP Code Description Schema

200

OK

PaginationResponse[BlacklistedEmail]

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • BlacklistedEmails

Example HTTP response

Response 200

{
  "totalCount" : 1,
  "items" : [ {
    "id" : 1,
    "emailAddress" : "test@example.com",
    "timestamp" : "2025-01-22T09:09:13.9308175Z",
    "unsubscribedFrom" : "p123456789"
  } ]
}

Export all emails

GET /optout/lists/{optOutListId}/emails/export

Description

Return all email addresses as .csv file

Parameters

Type Name Description Schema

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Responses

HTTP Code Description Schema

200

OK

No Content

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • BlacklistedEmails

Import files

POST /optout/lists/{optOutListId}/emails/import

Description

Import emails from .csv, .xlsx or .txt

Parameters

Type Name Description Schema

Path

optOutListId
required

The id of the opt-out list

integer (int64)

FormData

file
optional

File containing list of emails to import

file

Responses

HTTP Code Description Schema

200

OK

ImportResult

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Consumes

  • multipart/form-data

Produces

  • application/json

Tags

  • BlacklistedEmails

Example HTTP response

Response 200

{
  "newRows" : 1,
  "duplicatedRows" : 0,
  "invalidRows" : 0
}

Delete a email

DELETE /optout/lists/{optOutListId}/emails/{emailId}

Description

Deletes an email from the opt-out list.

Parameters

Type Name Description Schema

Path

emailId
required

The id of email address

integer (int64)

Path

optOutListId
required

The id of the opt-out list

integer (int64)

Responses

HTTP Code Description Schema

204

No Content

No Content

400

Bad Request

ApiErrorDetails

401

Unauthorized

No Content

403

Forbidden

ApiErrorDetails

404

Not Found

ApiErrorDetails

Produces

  • application/json

Tags

  • BlacklistedEmails

Adds user to blacklist in order to unsubscribe

POST /unsubscribe

Description

Return the HTML page for unsubscribe result

Parameters

Type Name Description Schema

Query

key
optional

The parameter for unsubscribe

string

Responses

HTTP Code Description Schema

200

OK

ContentResult

404

Not Found

ContentResult

429

Too Many Requests

ProblemDetails

Produces

  • text/html

Tags

  • Unsubscribe

Gets the default html from company

GET /unsubscribe

Description

Return the HTML page for unsubscribe

Parameters

Type Name Description Schema

Query

key
optional

The parameter for unsubscribe

string

Responses

HTTP Code Description Schema

200

OK

ContentResult

404

Not Found

ContentResult

429

Too Many Requests

ProblemDetails

Produces

  • text/html

Tags

  • Unsubscribe

Adds user to blacklist in order to unsubscribe

POST /unsubscribe/{encryptedParameter}

operation.deprecated

Description

Return the HTML page for unsubscribe result

Parameters

Type Name Description Schema

Path

encryptedParameter
required

The parameter for unsubscribe

string

Responses

HTTP Code Description Schema

200

OK

ContentResult

404

Not Found

ContentResult

429

Too Many Requests

ProblemDetails

Produces

  • text/html

Tags

  • Unsubscribe

Gets the default html from company

GET /unsubscribe/{encryptedParameter}

operation.deprecated

Description

Return the HTML page for unsubscribe

Parameters

Type Name Description Schema

Path

encryptedParameter
required

The parameter for unsubscribe

string

Responses

HTTP Code Description Schema

200

OK

ContentResult

404

Not Found

ContentResult

429

Too Many Requests

ProblemDetails

Produces

  • text/html

Tags

  • Unsubscribe