How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Campaigns API

Represents the primary resource used to control the behavior of the Talon.One Rule Engine.They combine rulesets, coupons, and limits into a single unit.See the [docs](https://docs.talon.one/docs/product/campaigns/overview).

Talon.One Campaigns API is one of 42 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, an API reference, API documentation, and a getting-started guide.

This API exposes 12 operations across 10 paths, and defines 88 schemas. It is described by OpenAPI 3.2.0.

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

12 operations 10 paths 88 schemas 1 DELETE8 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key, API Key
Resource Areas
1

Authentication & Security 3

Talon.One Campaigns API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (api_key_v1). An API key is passed in the header as Authorization (manager_auth). An API key is passed in the header as Authorization (management_key).

  • api_key_v1 — To authenticate with the Integration API, generate an API key in the Campaign Manager and prefix it with ApiKey-v1. To generate an API key: 1. Sign in to the C…
  • manager_auth — This authentication scheme relies on a bearer token that you can use to access all the endpoints of the Management API. To create the token: 1. Get a bearer to…
  • management_key — The API key authentication gives you access to the endpoints selected by the admin who created the key. Using an API key is the recommended authentication meth…

Paths & Operations 12

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

Campaigns 12

Represents the primary resource used to control the behavior of the Talon.One Rule Engine. They combine rulesets, coupons, and limits into a single unit. See the docs.

GET
/v1/integration/campaigns
List all running campaigns
integrationGetAllCampaigns 9 params → 200400401404
GET
/v1/applications/{applicationId}/campaigns
List campaigns
getCampaigns 16 params → 200400
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
POST
/v1/applications/{applicationId}/campaigns/{campaignId}/copy
Copy the campaign into the specified Application
copyCampaignToApplications 2 params body → 200
POST
/v1/applications/{applicationId}/campaigns_search
List campaigns that match the given attributes
getCampaignByAttributes 5 params body → 200
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets
List campaign rulesets
getRulesets 5 params → 200
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}
Get ruleset
getRuleset 3 params → 200
GET
/v2/applications/{applicationId}/campaigns/{campaignId}/rulesets/{rulesetId}
Get ruleset (V2)
getRulesetV2 3 params → 200
GET
/v1/applications/{applicationId}/campaigns/{campaignId}/analytics
Get analytics of campaigns
getCampaignAnalytics 5 params → 200
GET
/v1/applications/{applicationId}/campaign_analytics/export
Export Application analytics aggregated by campaign
exportApplicationCampaignAnalytics 4 params → 200

Schemas 88

The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are AdditionalCampaignProperties (25 properties), UpdateCampaign (18 properties), BaseCampaign (17 properties), RulesetV2 (11 properties). Each schema is shown below with its type and property counts.

ErrorResponseWithStatus
object
3 properties
ErrorSource
object
The source of the current error, exactly one of pointer, parameter or line will be defined.
4 properties
RuleMetadata
object
4 properties 1 required
APIError
object
3 properties 2 required
IntegrationCampaign
IntegrationCampaignBase
ApplicationEntity
object
1 property 1 required
AwardDiscountBundleItemByIndex
object
Identifies a bundle slot by its zero-based index within the bundle.
2 properties 2 required
BetweenCheckAttributeBlock
object
Variant of CheckAttributeBlock for the between operator, which requires both a minimum and maximum value.
3 properties 2 required
NewRuleset
object
5 properties 2 required
SelectorGroupBlock
PassthroughBlock
object
A block representing a Talang expression that could not be mapped to a typed block. The expression is preserved in its raw Talang array form for diagnostic and…
3 properties 3 required
AwardDiscountSelectorTarget
object
Applies the discount to items matched by a named selector binding.
3 properties 2 required
AdditionalCampaignProperties
object
25 properties 5 required
AwardDiscountBundleTarget
object
Applies the discount to items belonging to a named bundle.
4 properties 2 required
CreateReferralBlock
Binding
object
8 properties 2 required
MapSelectorStep
object
Transforms each item using an expression.
2 properties 2 required
AwardDiscountAdditionalCostTarget
object
Applies the discount to an additional cost. The target field determines which subset of cart items the additional cost contribution is applied to.
3 properties 3 required
StrikethroughCheckAttributeBlock
ReverseSelectorStep
object
Reverses the order of the items.
1 property 1 required
CampaignVersions
object
7 properties
BaseBlock
object
Common properties shared by all block types.
3 properties 2 required
UpdateAudienceMembershipBlock
AwardDiscountGlobalFilterTarget
object
Applies the discount to items matched by a named Application-level cart-item filter.
3 properties 2 required
ShowNotificationBlock
Entity
object
2 properties 2 required
Ruleset
FilterAndMapValuesSelectorStep
object
Keeps items that exist in the value map, and attaches each kept item's mapped value.
2 properties 2 required
SelectorStep
A single step in a selector item pipeline. The type field determines the step variant.
Campaign
AwardDiscountCartTarget
object
Applies the discount to the entire cart as a single unit.
1 property 1 required
UpdateAttributeValueBlock
AwardGiveawayBlock
CheckAttributeBlockBase
ReserveCouponBlock
UserEntity
object
1 property 1 required
RulesetV2
object
Ruleset in the V2 JSON block format.
11 properties 5 required
CreateCouponBlock
PromotionGroupBlock
CheckAchievementBlock
PromotionBlock
Describes a part of the logic of the rule.
AwardDiscountBundleItemByAttribute
object
Identifies a bundle slot by ranking items by a per-item attribute expression and picking the highest- or lowest-ranked one.
3 properties 3 required
CampaignCopy
object
7 properties 1 required
ListCheckAttributeBlock
object
Variant of CheckAttributeBlock for operators that test list membership against a set of values.
2 properties 1 required
StrikethroughBlock
A block valid in a strikethrough rule. The type field identifies the concrete block type.
CodeGeneratorSettings
object
2 properties 2 required
ListWithCountCheckAttributeBlock
object
Variant of CheckAttributeBlock for operators that test list membership with a minimum or exact count threshold.
3 properties 2 required
CheckReferralBlock
ReduceSelectorStep
object
Aggregates items into a single value.
2 properties 2 required
FilterSelectorStep
object
Filters only items that match a predicate block.
2 properties 2 required
StrikethroughRuleV2
RuleV2
object
Shared fields common to all V2 rule types.
4 properties 1 required
CampaignBudget
object
3 properties 3 required
PromotionRuleV2
UnaryCheckAttributeBlock
object
Variant of CheckAttributeBlock for operators that test a property of the attribute itself with no comparison value.
1 property
Selector
object
A named pipeline of steps (filter, sort, map, etc.) that filters or transforms a list of cart items. Replaces cartItemFilter [bindings](https://docs.talon.one/…
4 properties 4 required
LimitConfig
object
4 properties 3 required
UpdateCampaign
object
18 properties 4 required
SelectorBlock
A predicate block valid inside a selector filter step. The type field determines the block variant.
SelectSelectorStep
object
Picks a subset of the items by count, range, or exact position. The operator determines which additional fields are required: - many selects items from from (s…
7 properties 2 required
TriggerCustomEffectBlock
AwardDiscountAllItemsTarget
object
Applies the discount across all cart items.
2 properties 1 required
CheckBudgetBlock
AwardDiscountBlock
StrikethroughGroupBlock
SelectorValueMapRef
object
A reference to a value map by its internal ID.
1 property 1 required
CampaignAnalytics
AwardDiscountTarget
Identifies the scope a discount applies to. The type field selects the concrete target variant.
UpdateAchievementProgressBlock
CheckAttributeBlock
EntityWithTalangVisibleID
object
2 properties 2 required
CheckCouponBlock
TriggerWebhookBlock
PromotionCheckAttributeBlock
SortSelectorStepField
object
2 properties 2 required
ScalarCheckAttributeBlock
object
Variant of CheckAttributeBlock for operators that compare an attribute against a single value.
2 properties 1 required
WithinCheckAttributeBlock
object
Variant of CheckAttributeBlock for the within and not(within) operators, which require both a start and end value.
6 properties 2 required
AwardDiscountBundleItem
Selects which slot inside a bundle a discount applies to. The type field picks the selection mode.
CheckLoyaltyBalanceBlock
AdditionalCostReference
object
Identifies an additional cost referenced from a rule.
3 properties 2 required
Rule
object
7 properties 3 required
AwardItemBlock
BaseCampaign
object
17 properties 5 required
CheckAudienceBlock
CampaignSearch
object
1 property 1 required
CheckEventBlock
SortSelectorStep
object
Sorts items by one or more field expressions.
2 properties 2 required

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 Accounts and users API
Talon.One Achievements API
Talon.One Additional costs API
Talon.One Analytics API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Braze API
Talon.One Campaign access groups API
Talon.One Campaign notifications API
Talon.One Campaign templates API
Talon.One Catalogs API
Where this information came from

This is an independent, third-party profile of Talon.One Campaigns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.