GET
/
v1
/
email
/
unsubscribe
TypeScript client
import { TxAgentKitClient } from '@tx-agent-kit/sdk'

const client = new TxAgentKitClient({
  token: process.env.TX_AGENT_KIT_TOKEN
})

const response = await client.emailUnsubscribe.getUnsubscribe({
  query: {},
})
{
  "valid": true,
  "userId": "<string>",
  "campaignId": "<string>"
}

Query Parameters

token
string

Response

Success

valid
boolean
required
userId
string
required
campaignId
string | null
required