Skip to content

Subscription API โ€‹

Transfer Members โ€‹

prolog
POST /subscriptions/:list_id/members/:user_id/transfer?dst_list_id=:dst_list_id

Authorization Required โ€‹

OAuthAPIKey
NoYes

Parameters โ€‹

ParameterTypeDescription
list_iduint64The ID of the list
user_iduint64The ID of the user
dst_list_iduint64The ID of the destination list

Response โ€‹

json
{
  "data": 1,
  "ts": 1723923923
}

Update Email Sending Settings โ€‹

prolog
PUT /subscriptions/:list_id/members/:user_id/email

Authorization Required โ€‹

OAuthAPIKey
NoYes

Parameters โ€‹

ParameterTypeDescription
list_iduint64The ID of the list
user_iduint64The ID of the user

Request Body โ€‹

json
{
  "enabled": true // true or false
}

Response โ€‹

json
{
  "data": 1,
  "ts": 1723923923
}

Delete Member โ€‹

prolog
DELETE /subscriptions/:list_id/members/:user_id

Authorization Required โ€‹

OAuthAPIKey
NoYes

Parameters โ€‹

ParameterTypeDescription
list_iduint64The ID of the list
user_iduint64The ID of the user

Response โ€‹

json
{
  "data": 1,
  "ts": 1723923923
}

Add Member โ€‹

prolog
POST /auxilia/subscriptions/:list_id/members/add

Authorization Required โ€‹

This API is only available to the Quaily+ plan users

OAuthAPIKey
NoYes

Parameters โ€‹

ParameterTypeDescription
list_iduint64The ID of the list

Request Body โ€‹

json
{
  "members": [
    {
      "email": "test@example.com",
      "name": "Test User"
    },
    {
      "email": "test2@example.com",
      "name": "Test User 2"
    }
  ]
}

Response โ€‹

json
{
  "data": 1,
  "ts": 1723923923
}