Subscription Management

9min

Endpoints and functionality
The subscription* management endpoints allow you to:
see all available (webhook) subscriptions and related information 
see detailed information about your (webhook) subscriptions 
delete your subscriptions. 
📌* By subscriptions, we refer to webhook update subscriptions made in  member_changes endpoints. 
You will only be able to see the subscriptions connected to your token. 
See the endpoints and their functions below:
Endpoint
Function
/v1/subscriptions
See all your subscriptions, their status, creation, and expiration dates
/v1/subscriptions/{subsription_id}  
See the details of your active subscriptions
DELETE /v1/subscriptions/{subscription_id}
Delete your subscriptions
I want to see all my active subscriptions
Use the endpoint /v1/subscriptions to see all your available subscriptions, their statuses, creation and expiration dates:
Indicate if you want to see the details of active or expired subscriptions (expired = false OR expired = true) 

You will automatically see only active subscriptions if you omit the expired = true/false parameter. 

Indicate which page number you wish to see. 
Each page contains about 1000 subscriptions, so if you have more than 1000 subscriptions, you might need to indicate the page number. 
Replate {JWT} with your API token in the template below:
Request template
Request example
curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v1/subscriptions?expired=false&page=1' \
  -H 'accept: application/json' \
  -H 'Authorization: {JWT}'
curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v1/subscriptions?expired=false&page=1' \
  -H 'accept: application/json' \
  -H 'Authorization: {JWT}'
﻿
4. Send the request. 
5. Refer to the Body for information about your subscription status:
JSON
[
  {
    "id": "c8e295c0-2f85-473d-8bef-350526e6b30a",
    "status": "active",
    "created_at": "2024-09-18",
    "expiring_at": "2024-12-18"
  },
  {
    "id": "a85b2528-6190-4c91-8489-364b27ccbf81",
    "status": "active",
    "created_at": "2024-09-18",
    "expiring_at": "2024-12-18"
  }
]
[
  {
    "id": "c8e295c0-2f85-473d-8bef-350526e6b30a",
    "status": "active",
    "created_at": "2024-09-18",
    "expiring_at": "2024-12-18"
  },
  {
    "id": "a85b2528-6190-4c91-8489-364b27ccbf81",
    "status": "active",
    "created_at": "2024-09-18",
    "expiring_at": "2024-12-18"
  }
]
﻿
Data point
Description
Data type
id
Subscription identification key. 

Subscription ID is displayed in the response body after submitting a webhook subscription via member_changes endpoints
String
status
Subscription status (active or expired)
String
created_at
Subscription start date in YYYY-MM-DD format
String (date)
expiring_at
Subscription expiry date in YYYY-MM-DD format
String (date)
﻿
I want to see the details of my subscriptions
Use the endpoint /v1/subscriptions/{id} to see the details of your expired or active subscriptions:
Provide your subscription_ID*.
📌*Subscription ID is displayed in the response body after successfully submitting a webhook subscription via  member_changes endpoints.
Replate {JWT} with your API token. 
Request template
curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/{subscription_id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}'
curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/{subscription_id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}'
﻿
3. Send the request.
4. You will see the following information in the Response body:
JSON
{
  "id": "c8e295c0-2f85-473d-8bef-350526e6b30a",
  "status": "active",
  "created_at": "2024-09-18",
  "expiring_at": "2024-12-18",
  "entity": "member_changes",
  "es_dsl_query": null, 
  "filters": null,
  "last_webhook_sent": "2024-09-30"
}
{
  "id": "c8e295c0-2f85-473d-8bef-350526e6b30a",
  "status": "active",
  "created_at": "2024-09-18",
  "expiring_at": "2024-12-18",
  "entity": "member_changes",
  "es_dsl_query": null, 
  "filters": null,
  "last_webhook_sent": "2024-09-30"
}
﻿
Data point
Description
Data type
id
Subscription identification key. 
String
status
Subscription status (active or expired)
String
created_at
Subscription start date in YYYY-MM-DD format
String (date)
expiring_at
Subscription expiry date in YYYY-MM-DD format
String (date)
entity
Subscription entity
String
es_dsl_query
ES DSL query used to subscribe to changes in a list of profiles
String
filters
Search filters used to subscribe to changes in a list of profiles
String
last_webhook_sent
Time of last message sent to your webhook URL in YYYY-MM-DD format
String (date)
I want to delete my subscription
Use the endpoint DELETE /v1/subscriptions/{id} to make your subscriptions inactive. 
Use your subscription ID as input to request updates of member profiles or experience changes. 
Refer to the template below:
Template
curl -X 'DELETE' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/{subscription_id}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {JWT}'
curl -X 'DELETE' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/{subscription_id}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {JWT}'
﻿
﻿

Endpoint	Function
/v1/subscriptions	See all your subscriptions, their status, creation, and expiration dates
/v1/subscriptions/{subsription_id}	See the details of your active subscriptions
DELETE /v1/subscriptions/{subscription_id}	Delete your subscriptions

Data point	Description	Data type
id	Subscription identification key. Subscription ID is displayed in the response body after submitting a webhook subscription via member_changes endpoints	String
status	Subscription status (active or expired)	String
created_at	Subscription start date in YYYY-MM-DD format	String (date)
expiring_at	Subscription expiry date in YYYY-MM-DD format	String (date)

Data point	Description	Data type
id	Subscription identification key.	String
status	Subscription status (active or expired)	String
created_at	Subscription start date in YYYY-MM-DD format	String (date)
expiring_at	Subscription expiry date in YYYY-MM-DD format	String (date)
entity	Subscription entity	String
es_dsl_query	ES DSL query used to subscribe to changes in a list of profiles	String
filters	Search filters used to subscribe to changes in a list of profiles	String
last_webhook_sent	Time of last message sent to your webhook URL in YYYY-MM-DD format	String (date)

Updated 22 Nov 2024

Did this page help you?

Webhooks

POST Requests