Endpoints for creating and managing campaigns. A campaign represents a distribution of funds to multiple beneficiaries.
Talli Campaign Manager API (v2)
The Talli Campaign Manager API provides programmatic access to create and manage payout campaigns, payout instructions, and reports. This API powers the Talli console interface and can be integrated with third-party systems to automate workflows.
- Campaigns: Create and manage fund distribution campaigns.
- Campaign drafts: Create and manage campaign drafts.
- Payout Instructions: Send and track payments to beneficiaries.
- Payout Methods: View available payment methods (PayPal, ACH, gift cards, etc.).
- Payouts: Details about selected payout
- Gift Cards: View details of a gift card requested by the beneficiary
- Prepaid Cards: View details of a prepaid card requested by the beneficiary
- Transfers: View details of Paypal, Venmo or ACH transfer requested by the beneficiary
- Reports: Access analytics and statistics about campaign performance.
- Funding sources: Create and manage funding sources.
- Templates: Create and manage templates.
https://docs.talli.ai/_mock/reference/swagger/
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns?pageNumber=1&pageSize=20&payoutInstructionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&includeDetails=false' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "pageNumber": 0, "pageSize": 0, "totalPages": 0, "totalItems": 0, "data": [ { … } ] }
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: multipart/form-data' \
-F name=string \
-F fundingSourceId=c84f0983-d75c-4a10-a5e5-798ab594a841 \
-F welcomeHeadline=string \
-F campaignDescription=string \
-F campaignManager=string \
-F welcomeText=string \
-F iconFile=string \
-F payoutMethodIds=497f6eca-6276-4993-bfeb-53cbbbba6f08 \
-F expiryDate=2019-08-24 \
-F displayEndDate=2019-08-24 \
-F validMobilePhoneNumberRequiredToInitiatePayoutInstructions=true \
-F 'emailTemplates[property1]=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
-F 'emailTemplates[property2]=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
-F automaticReminders=None
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"op": "Unknown",
"value": {
"options": {
"propertyNameCaseInsensitive": true
},
"parent": {},
"root": {}
}
}
]
}'
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
OK
The welcome headline text that will be displayed in the application welcome screen.
URL to the campaign's icon image that will be displayed in the application welcome screen.
Available payout methods for this campaign.
Indicates whether a valid mobile phone number is required to initiate payout instructions.If this is disabled payouts with no phone number will be sent to customers, but some payout methods might be disabled.
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "fundingSourceId": "c84f0983-d75c-4a10-a5e5-798ab594a841", "welcomeHeadline": "string", "campaignDescription": "string", "campaignManager": "string", "welcomeText": "string", "iconUrl": "string", "payoutMethods": [ { … } ], "expiryDate": "2019-08-24", "displayEndDate": "2019-08-24", "creationDate": "2019-08-24", "validMobilePhoneNumberRequiredToInitiatePayoutInstructions": true, "emailTemplates": { "InitiateEmail": "503f450d-21f7-4241-8734-82f102b59ff5", "ReminderEmail": "03f0f4e9-1347-456b-b068-11b85982c26d", "FailureReinitiateEmail": "207ac805-d6ae-4273-ab26-39cbfcc79f64", "OtpEmail": "a3326353-6367-4e5f-8f06-0ff770a372f8", "PushEmail": "42bd2676-4464-4f74-b80c-1dd80b6a2e4d" } }
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}/campaign-icon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}/campaign-icon' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: multipart/form-data' \
-F iconFile=string
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}/payout-instructions/:upload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{id}/payout-instructions/:upload' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: multipart/form-data' \
-F file=string
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/payout-instructions/:get-sample-file
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/payout-instructions/:get-sample-file?size=20' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Request
Sends reminders for a given campaign. The endpoint allows send reminders either to the specified list of IDs or to payout instructions in the specified statuses. If neither of the above is specified, reminders will be sent to the payout instructions that have not been excluded, requested or fulfilled. If the list of ids is specified, you can also schedule the sending window with the 'distributionPeriodInSeconds' parameter. The schedule window will be automatically calculated based on the number of payout instructions found.
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{campaignId}/payout-instructions/:send-reminders
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{campaignId}/payout-instructions/:send-reminders' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"payoutInstructionIds": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"distributionPeriodInSeconds": 0,
"payoutInstructionStatuses": [
"Draft"
],
"dryRun": true
}'
{ "dryRun": true, "details": { "batchId": "5579c111-9c50-47e2-af92-f16d52e63189", "count": 0, "items": [ … ] } }
- Mock server
https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{campaignId}/:set-password
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/campaigns/{campaignId}/:set-password' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"campaignPassword": "string"
}'