Add Subscription

Add a subscription for one or more TahoeId's in order to receive alerts as soon as we receive data updates for those people. You can specify which type of alerts you would like to receive.

1. Add your access profile, username, and search type to the request headers.

❗️

Please Note:

DataAlertsAddSubscription will be the search type in your request headers for "galaxy-search-type"

• galaxy-ap-name: [Access Profile Name]
• galaxy-ap-password: [Access Profile Password]
• galaxy-client-session-id: (Optional) Session ID for logging
• galaxy-client-type: [Galaxy Client Type] (required for Javascript clients)
• galaxy-search-type: [DataAlertsAddSubscription]

2. Add search criteria to your request.

JSON

{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38e5cd",
  "subClientId": "",
  "alertType": "NewBestPublicAddress",
  "tahoeIds": [
    "G-XXXXXXXXXXXXXXXXXX1",
    "G-XXXXXXXXXXXXXXXXXX2",
    "G-XXXXXXXXXXXXXXXXXX3",
  ]
}

3. Set the desired pagination rules (defaults to 1000 results per page if not specified)

JSON

{
  "clientId": "9b0375f5-5053-465f-8086-08d98f38e5cd",
  "subClientId": "",
  "alertType": "NewBestPublicAddress",
  "tahoeIds": [
    "G-XXXXXXXXXXXXXXXXXX1",
    "G-XXXXXXXXXXXXXXXXXX2",
    "G-XXXXXXXXXXXXXXXXXX3",
  ]
  "Page": 1,
  "ResultsPerPage": 10
}

4. Submit your search.