Skip to content
/
Subscribe Contact

Subscribe Contact

Tool name: subscribe-contact-via-opt-in-process

Subscribes exactly one email or SMS channel of a KlickTipp contact through an opt-in process and creates or reuses the contact and requested reference. Its effects reach a real recipient: it may send a confirmation message and may start automations. It takes either an email address or a phone number, never both. Assigning the optional tag may start further automations or outbound events. Other channels and references are not changed.

Input schema

optInProcessIdinteger, >= 1required

ID of the opt-in process to run

approvalstringrequired

Exactly "subscribe-contact": acknowledges a confirmation message, automations and a changed real recipient

Value:"subscribe-contact"
emailnull or string, <= 250 characters

Email channel to subscribe; mutually exclusive with phoneNumber

Default:null
phoneNumbernull or string, <= 50 characters

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

Default:null
referenceIdinteger, >= 0

Subscription reference context to create or reuse; a non-zero ID must exist in the account

Default:0
tagIdnull or integer, >= 1

Tag to additionally assign to the contact after a successful subscription

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{
  "optInProcessId": 1,
  "approval": "subscribe-contact",
  "email": null,
  "phoneNumber": null,
  "referenceId": 0,
  "tagId": null,
  "accountId": null
}

Output schema

accountIdintegerrequired
subscriberIdintegerrequired
channelstringrequired
contactInfostringrequired
referenceIdintegerrequired
optInProcessIdintegerrequired
subscriptionStatusstringrequired
contactCreatedbooleanrequired
referenceCreatedbooleanrequired
Output example
{
  "accountId": 0,
  "subscriberId": 0,
  "channel": "string",
  "contactInfo": "string",
  "referenceId": 0,
  "optInProcessId": 0,
  "subscriptionStatus": "string",
  "contactCreated": true,
  "referenceCreated": true
}