Talon.One Segment 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 Segment. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.
This API exposes
13 operations
across 12 paths,
and defines 116 schemas.
It is described by OpenAPI 3.2.0.
Requests are made against a single base URL, https://integration.talon.one.
The identity and technical contract details declared by the specification.
id
integer
Unique ID for this entity.
referralCreatedEffectProps
object
The properties specific to the "referralCreated" effect. This gets triggered whenever a validated rule contained a "create referral" effect, and a referral cod…
1 property
1 required
addLoyaltyPointsEffectProps
object
The properties specific to the "addLoyaltyPoints" effect. This gets triggered whenever a validated rule contained an "add loyalty" effect. These points are aut…
12 properties
6 required
CreateAndUpdateAudienceRequest
object
2 properties
2 required
SegmentCustomerProfileRequest
loyalty
object
Customer specific information about loyalty points.
2 properties
1 required
updateLoyaltyCard
object
1 property
1 required
audienceChangeV2
object
2 properties
attributeInfo
object
2 properties
showNotificationEffectProps
object
The properties specific to the "showNotification" effect. This gets triggered whenever a validated rule contained a "show notification" effect.
3 properties
3 required
setDiscountPerAdditionalCostPerItemEffectProps
object
The properties specific to the "setDiscountPerAdditionalCostPerItem" effect. This gets triggered whenever a validated rule contained a "set discount per additi…
7 properties
5 required
additionalCost
object
1 property
entity
object
2 properties
2 required
addFreeItemEffectProps
object
The properties specific to the "addFreeItem" effect. This gets triggered whenever a validated rule contained an "add free item" effect.
2 properties
2 required
rollbackDeductedLoyaltyPointsEffectProps
object
The properties specific to the "rollbackDeductedLoyaltyPoints" effect. This effect is triggered whenever a previously closed session is cancelled and a deductL…
8 properties
6 required
ledgerInfo
object
7 properties
multipleIntegrationAudienceChanges
errorEffectProps
object
Whenever an error occurred during evaluation, we return an error effect. This should never happen for rules created in the rule builder.
1 property
1 required
addIntegrationAudienceIds
array
The external IDs of the audiences for the customer to join.
setDiscountEffectProps
object
The properties specific to the "setDiscount" effect. This gets triggered whenever a validated rule contained a "set discount" effect. This is a discount that s…
4 properties
2 required
CustomerProfileResponseV2
applicationEntity
object
1 property
1 required
returnedCartItem
object
2 properties
1 required
rollbackReferralEffectProps
object
The properties specific to the "rollbackReferral" effect. This gets triggered whenever previously closed session is now cancelled and a referral redemption was…
1 property
1 required
customerProfileID
string
The integration ID of the customer profile. If the customer profile does not exist, it will be created.
rejectReferralEffectProps
object
The properties specific to the "rejectReferral" effect. This gets triggered whenever the referral code was rejected. See rejectionReason for more info on why.
5 properties
2 required
SingleCustomerProfileIntegrationAudiencesRequest
object
1 property
couponRejectionReason
object
Holds a reference to the campaign, the coupon and the reason for which that coupon was rejected. Should only be present when there is a 'rejectCoupon' effect.
3 properties
3 required
addAudienceIds
array
The IDs of the audiences for the customer to join.
CustomerProfilesIntegrationAudiencesRequest
object
1 property
referralRejectionReason
object
Holds a reference to the campaign, the referral and the reason for which that referral was rejected. Should only be present when there is a 'rejectReferral' ef…
3 properties
3 required
integrationEntity
object
2 properties
2 required
attributesInfo
array
Allows you to set the type of the attribute to create instead of relying on auto-type detection. For example, if you have a hasClickedProduct attribute set to…
setDiscountPerAdditionalCostEffectProps
object
The properties specific to the "setDiscountPerAdditionalCost" effect. This gets triggered whenever a validated rule contained a "set per additional cost discou…
5 properties
4 required
audienceItem
object
2 properties
1 required
cartItem
object
14 properties
2 required
attributeValuePairs
object
Property to set the attributes of your choice to the values of your choice. You can use [built-in attributes](https://docs.talon.one/docs/dev/concepts/attribut…
loyaltyProgramLedgers
object
Customer specific information about loyalty points.
5 properties
4 required
CustomerProfilesAudiencesRequest
object
1 property
newReturn
object
1 property
1 required
willAwardGiveawayEffectProps
object
The properties specific to the "awardGiveaway" effect when the session is not closed yet. This effect replaces "awardGiveaway" only when updating a session wit…
3 properties
3 required
audienceId
string
The integration ID of this audience. If the audience comes from a third-party platform, set this property to the ID given by the third-party platform.
ruleFailureReason
object
Details about why a rule failed.
12 properties
5 required
SegmentCustomerProfileV2Request
object
3 properties
rejectCouponEffectProps
object
The properties specific to the "rejectCoupon" effect. This gets triggered whenever the coupon was rejected. See rejectionReason for more info on why.
5 properties
2 required
limitConfig
object
4 properties
3 required
importEntity
object
1 property
1 required
audienceChange
object
A list of audiences where the customer should be removed or added.
2 properties
accountEntity
object
1 property
1 required
CustomerProfileRequestV2
object
3 properties
SegmentTrackEventV2Request
object
3 properties
1 required
effectEntity
object
Definition of all properties that are present on all effects, independent of their type.
6 properties
5 required
CustomerProfileResponse
object
Contains all entities that might interest Talon.One integrations.
2 properties
TrackEventRequest
object
4 properties
3 required
setDiscountPerItemEffectProps
object
The properties specific to the setDiscountPerItem effect, triggered whenever a validated rule contained a "set per item discount" effect. This is a discount th…
10 properties
3 required
codeGeneratorSettings
object
2 properties
2 required
errorResponseWithStatus
object
3 properties
entityWithTalangVisibleID
object
2 properties
2 required
couponCreatedEffectProps
object
The properties specific to the "couponCreated" effect. This gets triggered whenever a validated rule contained a "create coupon" effect, and a coupon was creat…
2 properties
2 required
couponValue
object
1 property
showBundleMetadataEffectProps
object
The properties specific to the "ShowBundleMetadata" effect. This effect contains information that allows you to associate the discounts from a rule in a bundle…
3 properties
3 required
UpdateCustomerSessionRequest
object
3 properties
newCampaign
object
13 properties
5 required
IntegrationStateV2
object
Contains all entities that might interest Talon.One integrations. This is the response type returned by the v2 PUT customersession endpoint.
14 properties
3 required
addAudienceItems
array
The audiences for the customer to join.
acceptReferralEffectProps
object
The properties specific to the "acceptReferral" effect. TThis gets triggered whenever the referral code is valid and all other conditions in the rules of its c…
1 property
1 required
rollbackDiscountEffectProps
object
The properties specific to the "rollbackDiscount" effect. This gets triggered whenever previously closed session is now cancelled or partially returned and a s…
7 properties
2 required
integrationProfileEntity
object
1 property
redeemReferralEffectProps
object
The properties specific to the "redeemReferral" effect. This gets triggered whenever the referral code is valid, and a rule was triggered that contains a "rede…
2 properties
2 required
integrationAudienceChange
object
A list of external IDs of the audiences where the customer should be removed or added.
2 properties
userEntity
object
1 property
1 required
deductLoyaltyPointsEffectProps
object
The properties specific to the "deductLoyaltyPoints" effect. This gets triggered whenever a validated rule contained a condition to only trigger when the given…
7 properties
6 required
CustomerProfileIntegrationResponseV2
object
This is the response type returned by the updateCustomerProfileV2 endpoint.
9 properties
3 required
deleteAudienceIds
array
The IDs of the audiences for the customer to leave.
loyaltyProgramEntity
object
1 property
1 required
audienceName
string
The human-friendly display name for this audience.
triggerWebhookEffectProps
object
The properties specific to the "triggerWebhook" effect. This gets triggered whenever a validated rule contained a "trigger webhook" effect. This is communicate…
2 properties
2 required
SegmentCustomerProfileRequestV2
updateAttributeEffectProps
object
The properties specific to the "updateAttribute" effect. This gets triggered whenever a validated rule contained an "update an attribute" effect.
2 properties
2 required
rollbackCouponEffectProps
object
The properties specific to the "rollbackCoupon" effect. This gets triggered whenever previously closed session is now cancelled and a coupon redemption was can…
1 property
1 required
customEffectProps
object
Effect containing custom payload.
3 properties
3 required
rollbackAddedLoyaltyPointsEffectProps
object
The properties specific to the "rollbackAddedLoyaltyPoints" effect. This gets triggered whenever previously a closed session with an addLoyaltyPoints effect is…
8 properties
6 required
couponConstraints
object
4 properties
loyaltyCardProfileRegistration
object
2 properties
2 required
awardGiveawayEffectProps
object
The properties specific to the "awardGiveaway" effect. This effect contains information on the giveaway item, and which profile it was awarded to.
5 properties
5 required
deleteAudienceItems
array
The audiences for the customer to leave.
acceptCouponEffectProps
object
The properties specific to the "acceptCoupon" effect. This gets triggered whenever the coupon is valid and all other conditions in the rules of its campaign ar…
1 property
1 required
CustomerProfileRequest
object
3 properties
newAudience
object
3 properties
1 required
deleteIntegrationAudienceIds
array
The external IDs of the audiences for the customer to leave.
campaignEntity
object
1 property
1 required
referralConstraints
object
3 properties
1 required
couponLimitConfigs
object
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Talon.One publishes across the network.
