Skip to content
Reference
/
templates
/
Get template types

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.

Key Resources

  • 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.

Authentication

All requests require OAuth 2.0 authentication using Auth0 with appropriate scopes.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Talli API Support

api-support@talli.ai

License

Proprietary and Confidential

Languages
Servers
Mock server

https://docs.talli.ai/_mock/reference/swagger/

campaigns

Endpoints for creating and managing campaigns. A campaign represents a distribution of funds to multiple beneficiaries.

Operations

payout-instructions

Endpoints for creating and managing payout instructions. A payout instruction represents an intention to pay a specific amount of money to a beneficiary.It is associated with one and only one campaign.

Operations

payout-methods

Endpoints for viewing and managing available payout methods, such as ACH, PayPal, and gift cards.

Operations

reports

Endpoints for accessing analytics and reporting data about campaigns and payouts.

Operations

ach-transfers

Endpoints for managing ACH bank transfers as a payout method.

Operations

gift-cards

Endpoints for managing gift card payouts and retrieving gift card details.

Operations

paypal-transfers

Endpoints for managing PayPal payouts and retrieving PayPal transfer details.

Operations

prepaid-cards

Endpoints for managing prepaid card payouts and retrieving prepaid card details.

Operations

venmo-transfers

Endpoints for managing Venmo transfers and retrieving Venmo transaction details.

Operations

funding-sources

Represents an account connected to a business entity that can be used as a source of funds for one or multiple campaigns. Each funding source corresponds to a separate bank account in our payment system and maintains it's own banking details and fund management capabilities

Operations

campaign-drafts

Operations

templates

Operations

Get template types

Request

Retrieves a list of template types.

Security
oauth2
curl -i -X GET \
  https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/templates/template-types \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
templateTypeinteger(int32)(Talli.Api.Contracts.Templates.TemplateType)
Enum"InitiateEmail""ReminderEmail""FailureReinitiateEmail""OtpEmail""PushEmail"
descriptionstring

Description of the template type.

templateModelSchemaobject

Dictionary is used to store template model elements for a template type. Template model elements can be used in content fields. Elements can refer to an entire campaign (e.g., expiry date) or to a unique user (e.g., first name).

layoutobject(Talli.Api.Contracts.Templates.TemplateLayoutResponse)
]
Response
application/json
[
  {
    "templateType": "InitiateEmail",
    "description": "string",
    "templateModelSchema": { … },
    "layout": { … }
  }
]

Get template

Request

Retrieves a single template based on provided identifier.

Security
oauth2
Path
idstring(uuid)required
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/templates/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
idstring(uuid)

The unique identifier for the template.

templateTypeinteger(int32)(Talli.Api.Contracts.Templates.TemplateType)
Enum"InitiateEmail""ReminderEmail""FailureReinitiateEmail""OtpEmail""PushEmail"
namestring

The name of the template.

isActiveboolean or null

Indicates whether a template is active or not. If this is disabled, this template will not be used.

contentFieldsobject or null

The dictionary is used to store context fields. The template consists of content fields.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "templateType": "InitiateEmail",
  "name": "string",
  "isActive": true,
  "contentFields": {
    "property1": "string",
    "property2": "string"
  }
}

Update template

Request

Updates an existing template with the provided template.

Security
oauth2
Path
idstring(uuid)required
Bodyapplication/jsonrequired
templateTypeinteger(int32)(Talli.Api.Contracts.Templates.TemplateType)
Enum"InitiateEmail""ReminderEmail""FailureReinitiateEmail""OtpEmail""PushEmail"
namestring

The name of the template.

isActiveboolean or null

Indicates whether a template is active or not. If this is disabled, this template will not be used.

contentFieldsobject or null

The dictionary is used to store context fields. The template consists of content fields.

curl -i -X PUT \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/templates/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "templateType": "InitiateEmail",
    "name": "string",
    "isActive": true,
    "contentFields": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Accepted

Response
No content

Get templates

Request

Retrieves a paginated list of templates, optionally filtered by template type.

Security
oauth2
Query
pageNumberinteger(int32)
Default 1
pageSizeinteger(int32)
Default 20
templateTypeinteger(int32)(Talli.Api.Contracts.Templates.TemplateType)
Enum"InitiateEmail""ReminderEmail""FailureReinitiateEmail""OtpEmail""PushEmail"
curl -i -X GET \
  'https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/templates?pageNumber=1&pageSize=20&templateType=InitiateEmail' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
pageNumberinteger(int32)
pageSizeinteger(int32)
totalPagesinteger(int32)read-only
totalItemsinteger(int32)
dataArray of objects(Talli.Api.Contracts.Templates.TemplateResponse)
Response
application/json
{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalItems": 0,
  "data": [
    { … }
  ]
}

Create template

Request

Creates a new template with the specified details.

Security
oauth2
Bodyapplication/jsonrequired
templateTypeinteger(int32)(Talli.Api.Contracts.Templates.TemplateType)
Enum"InitiateEmail""ReminderEmail""FailureReinitiateEmail""OtpEmail""PushEmail"
namestring

The name of the template.

isActiveboolean or null

Indicates whether a template is active or not. If this is disabled, this template will not be used.

contentFieldsobject or null

The dictionary is used to store context fields. The template consists of content fields.

curl -i -X POST \
  https://docs.talli.ai/_mock/reference/swagger/v2/campaign-manager/templates \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "templateType": "InitiateEmail",
    "name": "string",
    "isActive": true,
    "contentFields": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Accepted

Response
No content