Overwrite subscription list

This page describes the Deprecated PCN system. It remains maintained for now but is scheduled removal. For all new implementations, please use the new PCN, documented here: [New] Product Change Notifications API

Overwrite the existing subscription list.

In order to use the Product change API, please make sure to refer to our guide on how to Sign your API requests to our standard. JWT Signing for Secure API Requests

Overwrite subscription list

put

https://api-tiqt-test.steq.it/v2https://api.tiqets.com/v2

/subscriptions/{id}

Path parameters

idstringRequired

Unique ID of the subscription list.

Example: 11

Header parameters

AuthorizationstringRequired

Token <Your_API_Key>.

Default: Token <Partner_API_key>.

Body

application/json

namestringOptional

An optional free-form name for the list.

subscription_typestringRequired

Currently only webhook subscription type is supported. There may be different subscription type in the future.

Example: webhook

target_endpointstringRequired

Partner notification URL.

Responses

200

Successful operation.

application/json

400

Bad Request -- Check your request parameters (typo in parameter or invalid value).

application/json

401

Unauthorized -- Your API key is incorrect.

application/json

403

Forbidden -- The endpoint or parameters are not allowed for the matching API key.

application/json

404

Not Found -- Requested resource/endpoint could not be found.

application/json

405

Method Not Allowed -- Check your request method.

application/json

429

Too Many Requests -- We currently apply a fair-use policy, but we might enforce limits in the future.

application/json

500

Internal Server Error -- We had a problem with our server. Try again later.

application/json

503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

application/json

put

/subscriptions/{id}

HTTPcURLJavaScriptPython

PUT /v2/subscriptions/{id} HTTP/1.1
Host: api-tiqt-test.steq.it
Authorization: Token <Partner_API_key>.
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "name": "Important product list one",
  "subscription_type": "webhook",
  "target_endpoint": "https://partner/notification/url",
  "products": [
    {
      "product_id": 973888
    },
    {
      "product_id": 973666
    },
    {
      "product_id": 929249
    }
  ]
}

{
  "success": true,
  "subscription_type": "webhook",
  "is_active": true,
  "name": "Important products",
  "target_endpoint": "https://partner/notification/url",
  "products": [
    {
      "product_id": 973888
    },
    {
      "product_id": 973666
    },
    {
      "product_id": 973698
    }
  ],
  "target_email": null,
  "id": 34
}