Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: NudgeLink Unsubscribe API
version: 0.1.0
tags:
- name: unsubscribe
paths:
/api/v1/unsubscribe:
get:
tags:
- unsubscribe
summary: Unsubscribe Page
description: 'The link in an email body opens a page with one button; the button
POSTs. A GET never changes anything (2026-10-13 release review SEC-8;
RFC 8058 §3): link scanners (Safe Links, Mimecast, Proofpoint), a
forwarded email or a colleague''s click used to opt the lead out — and,
with HubSpot connected, unsubscribe the contact from ALL of the client''s
HubSpot email. In English, Polish or Russian (``_page_language``).'
operationId: unsubscribe_page_api_v1_unsubscribe_get
parameters:
- name: token
in: query
required: true
schema:
type: string
title: Token
- name: accept-language
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept-Language
responses:
'200':
description: Successful Response
content:
text/html:
schema:
type: string
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- unsubscribe
summary: Unsubscribe
description: 'One-click unsubscribe. Sets ``Lead.email_opt_out=True`` on this lead
and on every lead of the same client with the same address, records the
address on the client''s suppression list (so it survives deletion and the
90-day purge), and stops the open (active or paused) sequences of this
lead, of those same-address rows and of the same person''s other rows by
LinkedIn profile (``_linkedin_twin_ids``). Renders a confirmation page.
We don''t require any authentication — CAN-SPAM requires opt-out be
processable in 10 days, and one-click is the Gmail/Outlook 2024
bulk-sender requirement. A valid but expired link still works. The
page speaks the lead''s language (``_lead_language``), else the browser''s.'
operationId: unsubscribe_api_v1_unsubscribe_post
parameters:
- name: token
in: query
required: true
schema:
type: string
title: Token
- name: accept-language
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Accept-Language
responses:
'200':
description: Successful Response
content:
text/html:
schema:
type: string
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer