Unsubscribe Contact

Tool name: unsubscribe-contact

Unsubscribes exactly one email or SMS channel of a KlickTipp contact. Its effects reach a real recipient: future subscribed-audience messages on that channel stop, and automations may run. It takes either an email address or a phone number, never both. Other channels of the same contact and all subscription references remain untouched.

Input schema

approvalstringrequired

Exactly "unsubscribe-contact": acknowledges a changed real recipient and automations

Value:"unsubscribe-contact"

emailnull or string, <= 250 characters

Email channel to unsubscribe; mutually exclusive with phoneNumber

Default:null

phoneNumbernull or string, <= 50 characters

SMS channel to unsubscribe in E.164 format; mutually exclusive with email

Default:null

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null

Input example

{
  "approval": "unsubscribe-contact",
  "email": null,
  "phoneNumber": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

subscriberIdintegerrequired

channelstringrequired

contactInfostringrequired

subscriptionStatusstringrequired

Output example

{
  "accountId": 0,
  "subscriberId": 0,
  "channel": "string",
  "contactInfo": "string",
  "subscriptionStatus": "string"
}