HubSpot

Subscriptions

Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining to a specific topic, brand, or an entire HubSpot account.

Endpoints 4

Status

  • GETGet subscription statuses for a contact/communication-preferences/v3/status/email/:emailAddressReturns a list of subscriptions and their status for a given contact.
  • POSTSubscribe a contact/communication-preferences/v3/subscribeSubscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.
  • POSTUnsubscribe a contact/communication-preferences/v3/unsubscribeUnsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return…

Definition

  • GETGet subscription definitions/communication-preferences/v3/definitionsGet a list of all subscription definitions for the portal

API details

Base URL
https://api.hubapi.com
Authentication
An API key in the hapikey query parameter
OAuth 2.0 (authorization code flow) with 3 scopes
An API key in the private-app-legacy header
Operations
4 operations on 4 pathsGET 2POST 2
Main resources
Status 3Definition 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version v3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Subscriptions in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Subscriptions collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the hapikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get subscription statuses for a contact” (GET /communication-preferences/v3/status/email/:emailAddress), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Subscriptions?

Subscriptions allow contacts to control what forms of communications they receive. Contacts can decide whether they want to receive communication pertaining… It is listed under Other and has 4 endpoints.

Who publishes the Subscriptions?

It is listed from HubSpot's public API description (an OpenAPI document), not published by HubSpot on Swastik Codes. Anyone who controls hubapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Subscriptions?

Requests go to https://api.hubapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the Subscriptions?

It accepts 3 methods: an API key in the hapikey query parameter; OAuth 2.0 (authorization code flow) with 3 scopes; an API key in the private-app-legacy header.

How many endpoints does the Subscriptions have?

4 operations on 4 paths (2 GET, 2 POST). The largest groups are Status, Definition.

Is forking the Subscriptions free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.