Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Campaigns API

Management API - campaigns and rulesets.

Talon.One Campaigns API is one of 13 APIs that Talon.One publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://yourbaseurl.talon.one.

6 operations 3 paths 1 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Talon.One Campaigns API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (integrationKey). An API key is passed in the header as Authorization (managementKey). By default, every request must be authenticated.

  • integrationKey — Integration API key with the ApiKey-v1 prefix, e.g. header "Authorization: ApiKey-v1 ".
  • managementKey — Management API key with the ManagementKey-v1 prefix, e.g. header "Authorization: ManagementKey-v1 ".

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaigns 6

Management API - campaigns and rulesets.

GET
/v1/applications/{applicationId}/campaigns
List campaigns
listCampaigns 1 param → 200
POST
/v1/applications/{applicationId}/campaigns
Create campaign
createCampaign 1 param body → 200
GET
/v1/applications/{applicationId}/campaigns/{campaignId}
Get campaign
getCampaign 2 params → 200
PUT
/v1/applications/{applicationId}/campaigns/{campaignId}
Update campaign
updateCampaign 2 params body → 200
DELETE
/v1/applications/{applicationId}/campaigns/{campaignId}
Delete campaign
deleteCampaign 2 params → 204
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets
List campaign rulesets
listCampaignRulesets 2 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Campaign (6 properties). Each schema is shown below with its type and property counts.

Campaign
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talon-one-campaigns-api-openapi.yml Raw ↑

Other APIs Talon.One publishes across the network.

Talon.One Account API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Collections API
Talon.One Coupons API
Talon.One Customer Profiles API
Talon.One Customer Sessions API
Talon.One Events API
Talon.One Exports API
Talon.One Loyalty API
Talon.One Referrals API