Retrieves a list of customer unsubscriptions

GET 
/unsubscriptions

Retrieves a list of customer unsubscriptions

Request

Query Parameters

filter object

Customer unsubscription filter

embed string

Customer unsubscription embedded sub-entities

Responses

200

OK

application/json

Schema

Schema

unsubscriptions

object[]

The list of customer unsubscriptions

Array [

id uuid

The id of the customer unsubscription

customer_id uuid

The id of the customer of the customer unsubscription

campaign_id uuid

The id of the campaign of the customer unsubscription

created_at date-time

The date and time when the customer unsubscription was created

_embedded

object

nullable

customer

object

id uuid

reference string

name string

source string

email email

phone string

anonymization boolean

salutation string

language bcp47

country iso-3166-alpha-2

gender string

Possible values: [M, F]

created_at date-time

campaign

object

oneOf

Campaign

id uuid

name string

active boolean

created_at date-time

updated_at date-time

deleted_at date-time

NullableObject

object

]

cursor

object

cursor

self string

Pagination link|cursor pointing to the current page.

first string

Pagination link|cursor pointing to the first page.

prev string

Pagination link|cursor pointing to the previous page.

next string

Pagination link|cursor pointing to the next page.

last string

Pagination link|cursor pointing to the last page.

Example (from schema)

{
  "unsubscriptions": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "campaign_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "created_at": "2024-07-29T15:51:28.071Z",
      "_embedded": {
        "customer": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "reference": "string",
          "name": "string",
          "source": "string",
          "email": "user@example.com",
          "phone": "string",
          "anonymization": true,
          "salutation": "string",
          "language": "string",
          "country": "string",
          "gender": "M",
          "created_at": "2024-07-29T15:51:28.071Z"
        },
        "campaign": {}
      }
    }
  ],
  "cursor": {
    "self": "string",
    "first": "string",
    "prev": "string",
    "next": "string",
    "last": "string"
  }
}

401

Unauthenticated

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

403

Unauthorized

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

404

Not found

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

422

Unprocessable Entity

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

500

Unknown error

application/problem+json

Schema

Schema

title string

A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non technical stakeholders and not localized); example: Service Unavailable

status int32

Possible values: >= 100 and < 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "title": "string",
  "status": 503,
  "detail": "Connection to database timed out",
  "instance": "string"
}

Loading...