Skip to content

Create Contact

Tool name: upsert-subscribed-contact

Adds one contact to a KlickTipp account by hand, with its contact-field values in the same call -- the Add Contact screen of the app. Takes an email address, a mobile number, or both. The contact is subscribed at once, through no opt-in process and without a confirmation message, so it is reachable by the next mailing; automations may start. Only for addresses the account may write to by hand: an address that unsubscribed is refused, the account needs the add-contacts permission, and the call counts against its daily import limit. An address the account already has is updated rather than added twice, and the values given overwrite what it held; the answer says so in alreadyExisted. An unknown field ID or tag is refused, never skipped. Use subscribe-contact-via-opt-in-process to let an address opt in through a named process instead.

Input schema

emailnull or string, <= 250 characters

Email address of the contact; at least one of email and phoneNumber is required

Default:null
phoneNumbernull or string, <= 50 characters

Mobile number with country code, as +49170... or 0049170...; at least one of email and phoneNumber is required

Default:null
tagIdnull or integer, >= 1

Manual tag to assign to the contact; omit for none

Default:null
fieldsArray of objects, <= 50 items

Contact field values to write with the contact, each {fieldId, value} as get-contact and search-custom-fields name them

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{ "email": null, "phoneNumber": null, "tagId": null, "fields": null, "accountId": null }

Output schema

accountIdintegerrequired
contactIdintegerrequired
emailstring or nullrequired
phoneNumberstring or nullrequired
subscriptionStatusstringrequired
tagIdinteger or nullrequired
fieldIdsArray of stringsrequired
alreadyExistedbooleanrequired
editUrlstringrequired
Output example
{ "accountId": 0, "contactId": 0, "email": "string", "phoneNumber": "string", "subscriptionStatus": "string", "tagId": 0, "fieldIds": [ "string" ], "alreadyExisted": true, "editUrl": "string" }