ClickFunnels Contacts::Unsubscribed Topic API
Contact topic opt-outs and consent-based resubscription.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/clickfunnels:clickfunnels-contacts-unsubscribedtopic-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: ClickFunnels Contacts::Unsubscribed Topic API
termsOfService: https://www.clickfunnels.com/terms-of-service
contact:
name: ClickFunnels API Team
url: https://developers.myclickfunnels.com
x-logo:
url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.
### For AI agents
This document is the catalogue: every operation ClickFunnels exposes over REST is described here, with a unique operationId, typed schemas, and the scopes it needs. It is served from `/openapi.json`, `/openapi.yaml`, `/api/openapi.{json,yaml}`, and `/api/v2/openapi.{json,yaml}` on the accounts host.
Three things it does not describe, each one request away:
- MCP server: the app-native Model Context Protocol server (Streamable HTTP, OAuth 2.1 with PKCE). Prefer it over raw REST when your client supports MCP - it describes itself at runtime.
- Skill guides, also as an Agent Skills index: one task guide per job (pages, blogs, products, orders, workflows, emails, courses, stats, external SDK pages). Read the guide that matches your job before your first write. llms.txt covers when to use ClickFunnels at all, how to get credentials, and how to behave around rate limits.
- Protected resource metadata (RFC 9728) and authorization server metadata (RFC 8414): the scope vocabulary and the OAuth endpoints. Dynamic client registration is for MCP clients only.
On ClickFunnels-owned API hosts (`myclickfunnels.com` and its subdomains), the OpenAPI specification responses and API authentication failures (401, or 403 for insufficient scope) carry those links in an RFC 8288 `Link` header, so clients can discover the documentation and authentication metadata from those responses. Requests sent through a customer''s custom domain keep the Bearer challenge but omit those discovery pointers.'
license:
name: MIT
url: https://opensource.org/licenses/MIT
version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
description: ClickFunnels API
variables:
subdomain:
default: myworkspace
security:
- BearerAuth: []
- OAuth2: []
tags:
- name: Contacts::UnsubscribedTopic
description: Contact topic opt-outs and consent-based resubscription.
paths:
/contacts/{contact_id}/unsubscribed_topics:
get:
tags:
- Contacts::UnsubscribedTopic
summary: List Contact Topic Opt-outs
description: List one row per topic the contact has opted out of, including archived topics with existing opt-outs. Subscribed topics are the workspace's active topics minus these rows. The contact's unsubscribed_at is the separate all-email flag and can be set with no topic rows.
operationId: listContactsUnsubscribedTopics
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/sort_order'
- $ref: '#/components/parameters/sort_property'
- name: filter
in: query
description: 'Filter by available properties in query params, like this: `api/v2/resources?filter[id]=value&filter[another_property]=value1,value2`. Check our Filtering guide for examples and all about filtering [here](https://developers.myclickfunnels.com/docs/filtering).
'
required: false
schema:
type: object
properties:
id:
type: string
description: Comma-separated numeric id values.
contact_id:
type: string
description: Comma-separated numeric contact_id values.
topic_id:
type: string
description: Comma-separated numeric topic_id values.
style: deepObject
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContactsUnsubscribedTopicAttributes'
example:
- id: 77
public_id: kQzRbX
contact_id: 4821
topic:
id: 15
public_id: AbCdEf
name: Promotions
created_at: '2026-10-01T09:12:44.000Z'
updated_at: '2026-10-01T09:12:44.000Z'
headers:
Pagination-Next:
$ref: '#/components/headers/PaginationNext'
Link:
$ref: '#/components/headers/Link'
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
'422':
$ref: '#/components/responses/InvalidPageSize'
'403':
$ref: '#/components/responses/WorkspaceGrantForbidden'
post:
tags:
- Contacts::UnsubscribedTopic
summary: Opt a Contact out of a Topic
description: Opt a contact out of one active topic in their workspace. Records a subscription change attributed to the API caller's membership and emits the contact topic-unsubscribed activity event. Does not change the separate all-email unsubscribed_at flag.
operationId: createContactsUnsubscribedTopics
parameters:
- name: contact_id
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- contacts_unsubscribed_topic
properties:
contacts_unsubscribed_topic:
$ref: '#/components/schemas/ContactsUnsubscribedTopicParameters'
example:
contacts_unsubscribed_topic:
topic_id: 12
responses:
'201':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContactsUnsubscribedTopicAttributes'
example:
id: 77
public_id: kQzRbX
contact_id: 4821
topic:
id: 15
public_id: AbCdEf
name: Promotions
created_at: '2026-10-01T09:12:44.000Z'
updated_at: '2026-10-01T09:12:44.000Z'
headers:
Location:
description: URL of the created topic opt-out.
schema:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
'403':
$ref: '#/components/responses/WorkspaceGrantForbidden'
'422':
description: Inactive, missing or foreign topic, or duplicate opt-out.
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
examples:
invalid_topic:
value:
error: 'Request unprocessable: Topic must be an active topic in this workspace'
hint: null
duplicate:
value:
error: 'Request unprocessable: Contact has already been taken'
hint: null
/workspaces/{workspace_id}/contacts/unsubscribed_topics:
get:
tags:
- Contacts::UnsubscribedTopic
summary: List Workspace Contact Topic Opt-outs
description: List topic opt-outs across the accessible workspace. Filter by id, contact_id or topic_id.
operationId: listWorkspaceContactsUnsubscribedTopics
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/per_page'
- $ref: '#/components/parameters/sort_order'
- $ref: '#/components/parameters/sort_property'
- name: filter
in: query
description: 'Filter by available properties in query params, like this: `api/v2/resources?filter[id]=value&filter[another_property]=value1,value2`. Check our Filtering guide for examples and all about filtering [here](https://developers.myclickfunnels.com/docs/filtering).
'
required: false
schema:
type: object
properties:
id:
type: string
description: Comma-separated numeric id values.
contact_id:
type: string
description: Comma-separated numeric contact_id values.
topic_id:
type: string
description: Comma-separated numeric topic_id values.
style: deepObject
explode: true
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ContactsUnsubscribedTopicAttributes'
example:
- id: 77
public_id: kQzRbX
contact_id: 4821
topic:
id: 15
public_id: AbCdEf
name: Promotions
created_at: '2026-10-01T09:12:44.000Z'
updated_at: '2026-10-01T09:12:44.000Z'
headers:
Pagination-Next:
$ref: '#/components/headers/PaginationNext'
Link:
$ref: '#/components/headers/Link'
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
'422':
$ref: '#/components/responses/InvalidPageSize'
'403':
$ref: '#/components/responses/WorkspaceGrantForbidden'
/contacts/unsubscribed_topics/{id}:
get:
tags:
- Contacts::UnsubscribedTopic
summary: Fetch Contact Topic Opt-out
description: Read a contact's topic opt-out.
operationId: getContactsUnsubscribedTopics
parameters:
- $ref: '#/components/parameters/id'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContactsUnsubscribedTopicAttributes'
example:
id: 77
public_id: kQzRbX
contact_id: 4821
topic:
id: 15
public_id: AbCdEf
name: Promotions
created_at: '2026-10-01T09:12:44.000Z'
updated_at: '2026-10-01T09:12:44.000Z'
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
'403':
$ref: '#/components/responses/WorkspaceGrantForbidden'
delete:
tags:
- Contacts::UnsubscribedTopic
summary: Resubscribe a Contact to a Topic
description: Resubscribe the contact by removing a topic opt-out. Obtain the contact's renewed consent before calling this endpoint (CAN-SPAM, GDPR, CASL). Records who changed the preference and when. This also clears the separate all-email unsubscribed_at flag if set, even for an archived topic. No contact.unsubscribed webhook fires; contact.updated fires only if unsubscribed_at changed.
operationId: removeContactsUnsubscribedTopics
parameters:
- $ref: '#/components/parameters/id'
responses:
'204':
description: No Content
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: API key missing or invalid
hint: 'Send the token as `Authorization: Bearer <token>`. Create one under Account > Team > Platform Applications (a workspace API key), or obtain one with OAuth 2.1; both use the same scopes. See https://developers.myclickfunnels.com/docs/authentication, or append .md to that URL for markdown.'
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
example:
error: 'Not found: Record missing'
hint: null
'403':
$ref: '#/components/responses/WorkspaceGrantForbidden'
'422':
description: The subscription change could not be saved; the opt-out and history are unchanged.
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
example:
error: Unable to remove topic opt-out
hint: null
components:
parameters:
id:
name: id
in: path
required: true
schema:
type: string
per_page:
name: per_page
in: query
required: false
description: Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The `Link` next-page URL keeps the value, so a client following it keeps the page size. More [in our guides](https://developers.myclickfunnels.com/docs/pagination).
schema:
type: integer
minimum: 1
default: 20
sort_property:
name: sort_property
in: query
description: 'Sort property of a list response. The default is id and thus the created_at order.
If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.
'
required: false
schema:
type: string
enum:
- id
- updated_at
sort_order:
name: sort_order
in: query
description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
required: false
schema:
type: string
enum:
- asc
- desc
after:
name: after
in: query
required: false
schema:
type: string
description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
responses:
WorkspaceGrantForbidden:
description: "Forbidden — this request's workspace is closed to it.\n\nThree cases return this:\n\n* The access token is limited to specific workspaces (see the workspace selection made when\n the key was provisioned, or the workspaces approved on the OAuth consent screen) and the\n request acts on a workspace outside that set.\n* The access token is limited to specific workspaces and the request's workspace could not be\n determined at all. The gate is fail-closed, so a workspace-limited token is denied rather\n than allowed through when the target workspace is ambiguous.\n* The workspace's team has no active ClickFunnels subscription: it was canceled, is paused,\n or is locked out after failed payments. Reads and writes are both refused until the\n subscription is reactivated, and the body carries `\"code\": \"subscription_inactive\"`.\n\nA token with no workspace restriction never receives the first two."
content:
application/json:
schema:
type: object
properties:
error:
type: string
code:
type: string
description: A machine-readable cause, when there is one. `subscription_inactive` means the workspace's team has no active ClickFunnels subscription.
enum:
- subscription_inactive
hint:
type:
- string
- 'null'
description: 'The next step for the caller: how to authenticate, which scope was missing, or where the route list lives. Always present, and null when this error has no next step to offer.'
examples:
workspace_not_granted:
summary: Token not granted this workspace
value:
error: 'Forbidden: This access token is limited to specific workspaces and was not granted access to this one.'
hint: The token's workspace grant was chosen when it was provisioned (Platform Applications) or on the OAuth consent screen. Use GET /api/v2/teams/{team_id}/workspaces to list the workspaces this token can reach (GET /api/v2/teams lists the team ids).
subscription_inactive:
summary: Team subscription inactive
value:
error: 'Forbidden: This workspace''s team does not have an active ClickFunnels subscription, so API access to it is disabled until the subscription is reactivated.'
hint: null
code: subscription_inactive
InvalidPageSize:
description: Unprocessable Entity - `per_page` must be a positive integer.
content:
application/json:
schema:
type: object
properties:
error:
type: string
hint:
type:
- string
- 'null'
description: Next step for the caller, or null when no additional guidance applies.
example:
error: 'Request unprocessable: per_page must be a positive integer, capped at 100 (got "0")'
hint: null
schemas:
ContactsUnsubscribedTopicParameters:
type: object
required:
- topic_id
properties:
topic_id:
type: integer
description: An active topic ID in the contact's workspace.
example:
topic_id: 12
ContactsUnsubscribedTopicAttributes:
type: object
title: Contact topic opt-out
properties:
id:
type: integer
public_id:
type: string
contact_id:
type: integer
topic:
type: object
properties:
id:
type: integer
public_id:
type: string
name:
type: string
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
example:
id: 77
public_id: kQzRbX
contact_id: 4821
topic:
id: 15
public_id: AbCdEf
name: Promotions
created_at: '2026-10-01T09:12:44.000Z'
updated_at: '2026-10-01T09:12:44.000Z'
headers:
PaginationNext:
description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
schema:
type: string
Link:
description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
schema:
type: string
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'A workspace API key or an OAuth access token, sent as `Authorization: Bearer <token>`.
Both carry the same scope vocabulary as the `OAuth2` scheme below. Category-only
scopes restrict access to the categories they name. Coarse wildcards remain additive:
`read contacts:read` reads every category, while `write contacts:read` can write every
category. Omit coarse scopes when restricting access to specific categories.
Legacy tokens with only coarse scopes retain their existing unrestricted access;
a bare `read` scope alone does not enforce read-only access.
'
OAuth2:
type: oauth2
description: 'OAuth 2.0 authorization code flow for REST integrations. Create a Platform Application
and follow `https://developers.myclickfunnels.com/docs/oauth-20` to connect users.
Authorization server metadata is published at
`https://accounts.myclickfunnels.com/.well-known/oauth-authorization-server`.
Dynamic client registration at `/oauth/register` is for MCP clients only; MCP-scoped
tokens must use `https://agents.myclickfunnels.com/mcp`, not the REST API.
Scopes are least-privilege by category. Ask for the two coarse wildcards (`read`,
`write`) only when an integration genuinely needs the whole workspace; otherwise ask
for the `<category>:read` / `<category>:write` pairs you use. `write` implies `read`
for the same category. Protected resource metadata (RFC 9728) for this API lives at
`https://accounts.myclickfunnels.com/.well-known/oauth-protected-resource`.
'
flows:
authorizationCode:
authorizationUrl: https://accounts.myclickfunnels.com/oauth/authorize
tokenUrl: https://accounts.myclickfunnels.com/oauth/token
refreshUrl: https://accounts.myclickfunnels.com/oauth/token
scopes:
read: Read any resource in the granted workspaces
write: Read and write any resource in the granted workspaces
contacts:read: Read Contacts
contacts:write: Read and write Contacts
workflows:read: Read Workflows (Automations)
workflows:write: Read and write Workflows (Automations)
funnels:read: Read Funnels
funnels:write: Read and write Funnels
sites:read: Read Sites & Design
sites:write: Read and write Sites & Design
courses:read: Read Courses
courses:write: Read and write Courses
emails:read: Read Emails
emails:write: Read and write Emails
blog:read: Read Blog
blog:write: Read and write Blog
community:read: Read Community
community:write: Read and write Community
appointments:read: Read Appointments
appointments:write: Read and write Appointments
opportunities:read: Read Opportunities
opportunities:write: Read and write Opportunities
store:read: Read Store
store:write: Read and write Store
forms:read: Read Forms
forms:write: Read and write Forms
media:read: Read Media
media:write: Read and write Media
webhooks:read: Read Webhooks
webhooks:write: Read and write Webhooks
account:read: Read Account
account:write: Read and write Account
reference:read: Read Reference Data
reference:write: Read and write Reference Data
externalDocs:
description: More in-depth guides and further resources
url: https://developers.myclickfunnels.com
x-provenance:
method: harvested
publisher: ClickFunnels
source: https://accounts.myclickfunnels.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)