Skip to content

Get Referral Program

Tool name: get-referral-program

Reads a referral program (contacts recommend the account through a personal link, a number field counts their successful recommendations, reaching the threshold tags them) with target URL, threshold, counter field and app link. Without an ID it returns the creation defaults, which, like creating, need referral program access; existing programs stay readable without it.

Input schema

idnull or integer, >= 1

ID of the program, from search-referral-programs; omit for the creation defaults

Default:null
accountIdnull or integer, >= 1

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

Default:null
Input example
{ "id": null, "accountId": null }

Output schema

accountIdintegerrequired
idintegerrequired
namestringrequired
notesstringrequired
metaLabelsArray of stringsrequired
targetUrlstringrequired
thresholdintegerrequired
counterCustomFieldIdstringrequired
editUrlstringrequired
Output example
{ "accountId": 0, "id": 0, "name": "string", "notes": "string", "metaLabels": [ "string" ], "targetUrl": "string", "threshold": 0, "counterCustomFieldId": "string", "editUrl": "string" }