Search code, repositories, users, issues, pull requests...

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: Not defined

AddLoyaltyCardPoints

AddLoyaltyCardPoints(ctx, loyaltyProgramId, loyaltyCardId, body)

Add points to card

Add points to the given loyalty card in the specified card-based loyalty program.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
body	AddLoyaltyPoints	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

AddLoyaltyPoints

AddLoyaltyPoints(ctx, loyaltyProgramId, integrationId, body)

Add points to customer profile

Add points in the specified loyalty program for the given customer. To get the integrationId of the profile from a sessionId, use the Update customer session endpoint.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	string	The identifier for the loyalty program.
integrationId	string	The identifier of the profile.
body	AddLoyaltyPoints	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CopyCampaignToApplications

InlineResponse2006 CopyCampaignToApplications(ctx, applicationId, campaignId, body)

Copy the campaign into the specified Application

Copy the campaign into all specified Applications.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	CampaignCopy	body

Return type

InlineResponse2006

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateAccountCollection

Collection CreateAccountCollection(ctx, body)

Create account-level collection

Create an account-level collection.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewCollection	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateAchievement

Achievement CreateAchievement(ctx, applicationId, campaignId, body)

Create achievement

Create a new achievement in a specific campaign.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	CreateAchievement	body

Return type

Achievement

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateAdditionalCost

AccountAdditionalCost CreateAdditionalCost(ctx, body)

Create additional cost

Create an additional cost. These additional costs are shared across all applications in your account, and are never required.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewAdditionalCost	body

Return type

AccountAdditionalCost

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateAttribute

Attribute CreateAttribute(ctx, body)

Create custom attribute

Create a custom attribute in this account. Custom attributes allow you to add data to Talon.One domain entities like campaigns, coupons, customers and so on. These attributes can then be given values when creating/updating these entities, and these values can be used in your campaign rules. For example, you could define a zipCode field for customer sessions, and add a rule to your campaign that only allows certain ZIP codes. These attributes are shared across all Applications in your account and are never required.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewAttribute	body

Return type

Attribute

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateBatchLoyaltyCards

LoyaltyCardBatchResponse CreateBatchLoyaltyCards(ctx, loyaltyProgramId, body)

Create loyalty cards

Create a batch of loyalty cards in a specified card-based loyalty program. Customers can use loyalty cards to collect and spend loyalty points. Important: - The specified card-based loyalty program must have a defined card code format that is used to generate the loyalty card codes. - Trying to create more than 20,000 loyalty cards in a single request returns an error message with a 400 status code.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
body	LoyaltyCardBatch	body

Return type

LoyaltyCardBatchResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateCampaignFromTemplate

CreateTemplateCampaignResponse CreateCampaignFromTemplate(ctx, applicationId, body)

Create campaign from campaign template

Use the campaign template referenced in the request body to create a new campaign in one of the connected Applications. If the template was created from a campaign with rules referencing campaign collections, the corresponding collections for the new campaign are created automatically.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
body	CreateTemplateCampaign	body

Return type

CreateTemplateCampaignResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateCollection

Collection CreateCollection(ctx, applicationId, campaignId, body)

Create campaign-level collection

Create a campaign-level collection in a given campaign.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	NewCampaignCollection	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateCoupons

InlineResponse2008 CreateCoupons(ctx, applicationId, campaignId, body, optional)

Create coupons

Create coupons according to some pattern. Up to 20.000 coupons can be created without a unique prefix. When a unique prefix is provided, up to 200.000 coupons can be created.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	NewCoupons	body
optional	*CreateCouponsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateCouponsOpts struct

Name	Type	Description	Notes

silent | optional.| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [default to yes]

Return type

InlineResponse2008

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateCouponsAsync

AsyncCouponCreationResponse CreateCouponsAsync(ctx, applicationId, campaignId, body)

Create coupons asynchronously

Create up to 5,000,000 coupons asynchronously. You should typically use this enpdoint when you create at least 20,001 coupons. You receive an email when the creation is complete. If you want to create less than 20,001 coupons, you can use the Create coupons endpoint.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	NewCouponCreationJob	body

Return type

AsyncCouponCreationResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateCouponsDeletionJob

AsyncCouponDeletionJobResponse CreateCouponsDeletionJob(ctx, applicationId, campaignId, body)

Creates a coupon deletion job

This endpoint handles creating a job to delete coupons asynchronously.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	NewCouponDeletionJob	body

Return type

AsyncCouponDeletionJobResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateCouponsForMultipleRecipients

InlineResponse2008 CreateCouponsForMultipleRecipients(ctx, applicationId, campaignId, body, optional)

Create coupons for multiple recipients

Create coupons according to some pattern for up to 1000 recipients.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	NewCouponsForMultipleRecipients	body
optional	*CreateCouponsForMultipleRecipientsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a CreateCouponsForMultipleRecipientsOpts struct

Name	Type	Description	Notes

silent | optional.| Possible values: `yes` or `no`. - `yes`: Increases the perfomance of the API call by returning a 204 response. - `no`: Returns a 200 response that contains the updated customer profiles. | [default to yes]

Return type

InlineResponse2008

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateInviteEmail

NewInviteEmail CreateInviteEmail(ctx, body)

Resend invitation email

Resend an email invitation to an existing user. Note: The invitation token is valid for 24 hours after the email has been sent.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewInviteEmail	body

Return type

NewInviteEmail

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateInviteV2

User CreateInviteV2(ctx, body)

Invite user

Create a new user in the account and send an invitation to their email address. Note: The invitation token is valid for 24 hours after the email has been sent. You can resend an invitation to a user with the Resend invitation email endpoint.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewInvitation	body

Return type

User

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreatePasswordRecoveryEmail

NewPasswordEmail CreatePasswordRecoveryEmail(ctx, body)

Request a password reset

Send an email with a password recovery link to the email address of an existing account. Note: The password recovery link expires 30 minutes after this endpoint is triggered.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewPasswordEmail	body

Return type

NewPasswordEmail

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateSession

Session CreateSession(ctx, body)

Create session

Create a session to use the Management API endpoints. Use the value of the token property provided in the response as bearer token in other API calls. A token is valid for 3 months. In accordance with best pratices, use your generated token for all your API requests. Do not regenerate a token for each request. This endpoint has a rate limit of 3 to 6 requests per second per account, depending on your setup. <div class="redoc-section"> <p class="title">Granular API key

Instead of using a session, you can also use the <a href="https://docs.talon.one/docs/product/account/dev-tools/managing-mapi-keys\">Management API key feature in the Campaign Manager to decide which endpoints can be used with a given key.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	LoginParams	body

Return type

Session

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

CreateStore

Store CreateStore(ctx, applicationId, body)

Create store

Create a new store in a specific Application.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
body	NewStore	body

Return type

Store

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

DeactivateUserByEmail

DeactivateUserByEmail(ctx, body)

Disable user by email address

Disable a specific user by their email address.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	DeactivateUserRequest	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: Not defined

DeductLoyaltyCardPoints

DeductLoyaltyCardPoints(ctx, loyaltyProgramId, loyaltyCardId, body)

Deduct points from card

Deduct points from the given loyalty card in the specified card-based loyalty program.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
body	DeductLoyaltyPoints	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

DeleteAccountCollection

DeleteAccountCollection(ctx, collectionId)

Delete account-level collection

Delete a given account-level collection.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	int32	The ID of the collection. You can get it with the List collections in account endpoint.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

DeleteAchievement

DeleteAchievement(ctx, applicationId, campaignId, achievementId)

Delete achievement

Delete the specified achievement.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
achievementId	int32	The ID of the achievement. You can get this ID with the List achievement endpoint.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

DeleteCampaign

DeleteCampaign(ctx, applicationId, campaignId)

Delete campaign

Delete the given campaign.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

DeleteCollection

DeleteCollection(ctx, applicationId, campaignId, collectionId)

Delete campaign-level collection

Delete a given campaign-level collection.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
collectionId	int32	The ID of the collection. You can get it with the List collections in Application endpoint.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

DeleteCoupon

DeleteCoupon(ctx, applicationId, campaignId, couponId)

Delete coupon

Delete the specified coupon.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
couponId	string	The internal ID of the coupon code. You can find this value in the `id` property from the List coupons endpoint response.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

DeleteCoupons

DeleteCoupons(ctx, applicationId, campaignId, optional)

Delete coupons

Deletes all the coupons matching the specified criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*DeleteCouponsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a DeleteCouponsOpts struct

Name	Type	Description	Notes

value | optional.| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | startsAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | startsBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | expiresAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | expiresBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| - `expired`: Matches coupons in which the expiration date is set and in the past. - `validNow`: Matches coupons in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches coupons in which start date is set and in the future. | batchId | optional.| Filter results by batches of coupons | usable | optional.| - `true`: only coupons where `usageCounter < usageLimit` will be returned. - `false`: only coupons where `usageCounter >= usageLimit` will be returned. | referralId | optional.| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | recipientIntegrationId | optional.| Filter results by match with a profile ID specified in the coupon's `RecipientIntegrationId` field. | exactMatch | optional.| Filter results to an exact case-insensitive matching against the coupon code | [default to false]

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

DeleteLoyaltyCard

DeleteLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId)

Delete loyalty card

Delete the given loyalty card.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

DeleteReferral

DeleteReferral(ctx, applicationId, campaignId, referralId)

Delete referral

Delete the specified referral.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
referralId	string	The ID of the referral code.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

DeleteStore

DeleteStore(ctx, applicationId, storeId)

Delete store

Delete the specified store.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
storeId	string	The ID of the store. You can get this ID with the List stores endpoint.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

DeleteUser

DeleteUser(ctx, userId)

Delete user

Delete a specific user.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

DeleteUserByEmail

DeleteUserByEmail(ctx, body)

Delete user by email address

Delete a specific user by their email address.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	DeactivateUserRequest	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: Not defined

DestroySession

DestroySession(ctx, )

Destroy session

Destroys the session.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

DisconnectCampaignStores

DisconnectCampaignStores(ctx, applicationId, campaignId)

Disconnect stores

Disconnect the stores linked to a specific campaign.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ExportAccountCollectionItems

string ExportAccountCollectionItems(ctx, collectionId)

Export account-level collection's items

Download a CSV file containing items from a given account-level collection. Tip: If the exported CSV file is too large to view, you can split it into multiple files.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	int32	The ID of the collection. You can get it with the List collections in account endpoint.

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportAchievements

string ExportAchievements(ctx, applicationId, campaignId, achievementId)

Export achievement customer data

Download a CSV file containing a list of all the customers who have participated in and are currently participating in the given achievement. The CSV file contains the following columns: - profileIntegrationID: The integration ID of the customer profile participating in the achievement. - title: The display name of the achievement in the Campaign Manager. - target: The required number of actions or the transactional milestone to complete the achievement. - progress: The current progress of the customer in the achievement. - status: The status of the achievement. Can be one of: ['inprogress', 'completed', 'expired']. - startDate: The date on which the customer profile started the achievement in RFC3339. - endDate: The date on which the achievement ends and resets for the customer profile in RFC3339. - completionDate: The date on which the customer profile completed the achievement in RFC3339.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
achievementId	int32	The ID of the achievement. You can get this ID with the List achievement endpoint.

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportAudiencesMemberships

string ExportAudiencesMemberships(ctx, audienceId)

Export audience members

Download a CSV file containing the integration IDs of the members of an audience. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The file contains the following column: - profileintegrationid: The integration ID of the customer profile.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
audienceId	int32	The ID of the audience.

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportCampaignStores

string ExportCampaignStores(ctx, applicationId, campaignId)

Export stores

Download a CSV file containing the stores linked to a specific campaign. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The CSV file contains the following column: - store_integration_id: The identifier of the store.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportCollectionItems

string ExportCollectionItems(ctx, applicationId, campaignId, collectionId)

Export campaign-level collection's items

Download a CSV file containing items from a given campaign-level collection. Tip: If the exported CSV file is too large to view, you can split it into multiple files.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
collectionId	int32	The ID of the collection. You can get it with the List collections in Application endpoint.

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportCoupons

string ExportCoupons(ctx, applicationId, optional)

Export coupons

Download a CSV file containing the coupons that match the given properties. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The CSV file can contain the following columns: - accountid: The ID of your deployment. - applicationid: The ID of the Application this coupon is related to. - attributes: A json object describing custom referral attribute names and their values. - batchid: The ID of the batch this coupon is part of. - campaignid: The ID of the campaign this coupon is related to. - counter: The number of times this coupon has been redeemed. - created: The creation date in RFC3339 of the coupon code. - deleted: Whether the coupon code is deleted. - deleted_changelogid: The ID of the delete event in the logs. - discount_counter: The amount of discount given by this coupon. - discount_limitval: The maximum discount amount that can be given be this coupon. - expirydate: The end date in RFC3339 of the code redemption period. - id: The internal ID of the coupon code. - importid: The ID of the import job that created this coupon. - is_reservation_mandatory: Whether this coupon requires a reservation to be redeemed. - limits: The limits set on this coupon. - limitval: The maximum number of redemptions of this code. - recipientintegrationid: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - referralid: The ID of the referral code that triggered the creation of this coupon (create coupon effect). - reservation: Whether the coupon can be reserved for multiple customers. - reservation_counter: How many times this coupon has been reserved. - reservation_limitval: The maximum of number of reservations this coupon can have. - startdate: The start date in RFC3339 of the code redemption period. - value: The coupon code.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*ExportCouponsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportCouponsOpts struct

Name	Type	Description	Notes

campaignId | optional.| Filter results by campaign ID. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | value | optional.| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | usable | optional.| Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. | referralId | optional.| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | recipientIntegrationId | optional.| Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field. | batchId | optional.| Filter results by batches of coupons | exactMatch | optional.| Filter results to an exact case-insensitive matching against the coupon code. | [default to false] dateFormat | optional.| Determines the format of dates in the export document. | campaignState | optional.| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | valuesOnly | optional.| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [default to false]

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportCustomerSessions

string ExportCustomerSessions(ctx, applicationId, optional)

Export customer sessions

Download a CSV file containing the customer sessions that match the request. Important: Archived sessions cannot be exported. See the retention policy. Tip: If the exported CSV file is too large to view, you can split it into multiple files. - id: The internal ID of the session. - firstsession: Whether this is a first session. - integrationid: The integration ID of the session. - applicationid: The ID of the Application. - profileid: The internal ID of the customer profile. - profileintegrationid: The integration ID of the customer profile. - created: The timestamp when the session was created. - state: The state of the session. - cartitems: The cart items in the session. - discounts: The discounts in the session. - total: The total value of cart items and additional costs in the session, before any discounts are applied. - attributes: The attributes set in the session. - closedat: Timestamp when the session was closed. - cancelledat: Timestamp when the session was cancelled. - referral: The referral code in the session. - identifiers: The identifiers in the session. - additional_costs: The additional costs in the session. - updated: Timestamp of the last session update. - store_integration_id: The integration ID of the store. - coupons: Coupon codes in the session.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*ExportCustomerSessionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportCustomerSessionsOpts struct

Name	Type	Description	Notes

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportCustomersTiers

string ExportCustomersTiers(ctx, loyaltyProgramId, optional)

Export customers' tier data

Download a CSV file containing the tier information for customers of the specified loyalty program. The generated file contains the following columns: - programid: The identifier of the loyalty program. It is displayed in your Talon.One deployment URL. - subledgerid: The ID of the subledger associated with the loyalty program. This column is empty if the loyalty program has no subledger. In this case, refer to the export file name to get the ID of the loyalty program. - customerprofileid: The ID used to integrate customer profiles with the loyalty program. - tiername: The name of the tier. - startdate: The tier start date in RFC3339. - expirydate: The tier expiry date in RFC3339. You can filter the results by providing the following optional input parameters: - subledgerIds (optional): Filter results by an array of subledger IDs. If no value is provided, all subledger data for the specified loyalty program will be exported. - tierNames (optional): Filter results by an array of tier names. If no value is provided, all tier data for the specified loyalty program will be exported.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	string	The identifier for the loyalty program.
optional	*ExportCustomersTiersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportCustomersTiersOpts struct

Name	Type	Description	Notes

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportEffects

string ExportEffects(ctx, applicationId, optional)

Export triggered effects

Download a CSV file containing the triggered effects that match the given attributes. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The generated file can contain the following columns: - applicationid: The ID of the Application. - campaignid: The ID of the campaign. - couponid: The ID of the coupon, when applicable to the effect. - created: The timestamp of the effect. - event_type: The name of the event. See the docs. - eventid: The internal ID of the effect. - name: The effect name. See the docs. - profileintegrationid: The ID of the customer profile, when applicable. - props: The properties of the effect. - ruleindex: The index of the rule. - rulesetid: The ID of the rule set. - sessionid: The internal ID of the session that triggered the effect. - profileid: The internal ID of the customer profile. - sessionintegrationid: The integration ID of the session. - total_revenue: The total revenue. - store_integration_id: The integration ID of the store. You choose this ID when you create a store.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*ExportEffectsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportEffectsOpts struct

Name	Type	Description	Notes

campaignId | optional.| Filter results by campaign ID. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally. | dateFormat | optional.| Determines the format of dates in the export document. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportLoyaltyBalance

string ExportLoyaltyBalance(ctx, loyaltyProgramId, optional)

Export customer loyalty balance to CSV

⚠️ Deprecation notice: Support for requests to this endpoint will end soon. To export customer loyalty balances to CSV, use the Export customer loyalty balances to CSV endpoint. Download a CSV file containing the balance of each customer in the loyalty program. Tip: If the exported CSV file is too large to view, you can split it into multiple files.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	string	The identifier for the loyalty program.
optional	*ExportLoyaltyBalanceOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportLoyaltyBalanceOpts struct

Name	Type	Description	Notes

endDate | optional.| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportLoyaltyBalances

string ExportLoyaltyBalances(ctx, loyaltyProgramId, optional)

Export customer loyalty balances

Download a CSV file containing the balance of each customer in the loyalty program. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The generated file can contain the following columns: - loyaltyProgramID: The ID of the loyalty program. - loyaltySubledger: The name of the subdleger, when applicatble. - profileIntegrationID: The integration ID of the customer profile. - currentBalance: The current point balance. - pendingBalance: The number of pending points. - expiredBalance: The number of expired points. - spentBalance: The number of spent points. - currentTier: The tier that the customer is in at the time of the export.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	string	The identifier for the loyalty program.
optional	*ExportLoyaltyBalancesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportLoyaltyBalancesOpts struct

Name	Type	Description	Notes

endDate | optional.| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportLoyaltyCardBalances

string ExportLoyaltyCardBalances(ctx, loyaltyProgramId, optional)

Export all card transaction logs

Download a CSV file containing the balances of all cards in the loyalty program. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The CSV file contains the following columns: - loyaltyProgramID: The ID of the loyalty program. - loyaltySubledger: The name of the subdleger, when applicatble. - cardIdentifier: The alphanumeric identifier of the loyalty card. - cardState:The state of the loyalty card. It can be active or inactive. - currentBalance: The current point balance. - pendingBalance: The number of pending points. - expiredBalance: The number of expired points. - spentBalance: The number of spent points.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
optional	*ExportLoyaltyCardBalancesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportLoyaltyCardBalancesOpts struct

Name	Type	Description	Notes

endDate | optional.| Used to return expired, active, and pending loyalty balances before this timestamp. You can enter any past, present, or future timestamp value. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportLoyaltyCardLedger

string ExportLoyaltyCardLedger(ctx, loyaltyProgramId, loyaltyCardId, rangeStart, rangeEnd, optional)

Export card's ledger log

Download a CSV file containing a loyalty card ledger log of the loyalty program. Tip: If the exported CSV file is too large to view, you can split it into multiple files.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
rangeStart	time.Time	Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
rangeEnd	time.Time	Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
optional	*ExportLoyaltyCardLedgerOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportLoyaltyCardLedgerOpts struct

Name	Type	Description	Notes

dateFormat | optional.| Determines the format of dates in the export document. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportLoyaltyCards

string ExportLoyaltyCards(ctx, loyaltyProgramId, optional)

Export loyalty cards

Download a CSV file containing the loyalty cards from a specified loyalty program. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The CSV file contains the following columns: - identifier: The unique identifier of the loyalty card. - created: The date and time the loyalty card was created. - status: The status of the loyalty card. - userpercardlimit: The maximum number of customer profiles that can be linked to the card. - customerprofileids: Integration IDs of the customer profiles linked to the card. - blockreason: The reason for transferring and blocking the loyalty card. - generated: An indicator of whether the loyalty card was generated. - batchid: The ID of the batch the loyalty card is in.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
optional	*ExportLoyaltyCardsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportLoyaltyCardsOpts struct

Name	Type	Description	Notes

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportLoyaltyLedger

string ExportLoyaltyLedger(ctx, rangeStart, rangeEnd, loyaltyProgramId, integrationId, optional)

Export customer's transaction logs

Download a CSV file containing a customer's transaction logs in the loyalty program. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The generated file can contain the following columns: - customerprofileid: The ID of the profile. - customersessionid: The ID of the customer session. - rulesetid: The ID of the rule set. - rulename: The name of the rule. - programid: The ID of the loyalty program. - type: The transaction type, such as addition or subtraction. - name: The reason for the transaction. - subledgerid: The ID of the subledger, when applicable. - startdate: The start date of the program. - expirydate: The expiration date of the program. - id: The ID of the transaction. - created: The timestamp of the creation of the loyalty program. - amount: The number of points in that transaction. - archived: Whether the session related to the transaction is archived. - campaignid: The ID of the campaign.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
rangeStart	time.Time	Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
rangeEnd	time.Time	Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
loyaltyProgramId	string	The identifier for the loyalty program.
integrationId	string	The identifier of the profile.
optional	*ExportLoyaltyLedgerOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportLoyaltyLedgerOpts struct

Name	Type	Description	Notes

dateFormat | optional.| Determines the format of dates in the export document. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportPoolGiveaways

string ExportPoolGiveaways(ctx, poolId, optional)

Export giveaway codes of a giveaway pool

Download a CSV file containing the giveaway codes of a specific giveaway pool. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The CSV file contains the following columns: - id: The internal ID of the giveaway. - poolid: The internal ID of the giveaway pool. - code: The giveaway code. - startdate: The validity start date in RFC3339 of the giveaway (can be empty). - enddate: The validity end date in RFC3339 of the giveaway (can be empty). - attributes: Any custom attributes associated with the giveaway code (can be empty). - used: An indication of whether the giveaway is already awarded. - importid: The ID of the import which created the giveaway. - created: The creation time of the giveaway code. - profileintegrationid: The third-party integration ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded. - profileid: The internal ID of the customer profile that was awarded the giveaway. Can be empty if the giveaway was not awarded or an internal ID does not exist.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
poolId	int32	The ID of the pool. You can find it in the Campaign Manager, in the Giveaways section.
optional	*ExportPoolGiveawaysOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportPoolGiveawaysOpts struct

Name	Type	Description	Notes

createdBefore | optional.| Timestamp that filters the results to only contain giveaways created before this date. Must be an RFC3339 timestamp string. | createdAfter | optional.| Timestamp that filters the results to only contain giveaways created after this date. Must be an RFC3339 timestamp string. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

ExportReferrals

string ExportReferrals(ctx, applicationId, optional)

Export referrals

Download a CSV file containing the referrals that match the given parameters. Tip: If the exported CSV file is too large to view, you can split it into multiple files. The CSV file contains the following columns: - code: The referral code. - advocateprofileintegrationid: The profile ID of the advocate. - startdate: The start date in RFC3339 of the code redemption period. - expirydate: The end date in RFC3339 of the code redemption period. - limitval: The maximum number of redemptions of this code. Defaults to 1 when left blank. - attributes: A json object describing custom referral attribute names and their values.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*ExportReferralsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExportReferralsOpts struct

Name	Type	Description	Notes

campaignId | optional.| Filter results by campaign ID. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| - `expired`: Matches referrals in which the expiration date is set and in the past. - `validNow`: Matches referrals in which start date is null or in the past and expiration date is null or in the future. - `validFuture`: Matches referrals in which start date is set and in the future. | usable | optional.| - `true`, only referrals where `usageCounter < usageLimit` will be returned. - `false`, only referrals where `usageCounter >= usageLimit` will be returned. | batchId | optional.| Filter results by batches of referrals | dateFormat | optional.| Determines the format of dates in the export document. |

Return type

string

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/csv

GetAccessLogsWithoutTotalCount

InlineResponse20019 GetAccessLogsWithoutTotalCount(ctx, applicationId, rangeStart, rangeEnd, optional)

Get access logs for Application

Retrieve the list of API calls sent to the specified Application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
rangeStart	time.Time	Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
rangeEnd	time.Time	Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
optional	*GetAccessLogsWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAccessLogsWithoutTotalCountOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20019

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAccount

Account GetAccount(ctx, accountId)

Get account details

Return the details of your companies Talon.One account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	int32	The identifier of the account. Retrieve it via the List users in account endpoint in the `accountId` property.

Return type

Account

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAccountAnalytics

AccountAnalytics GetAccountAnalytics(ctx, accountId)

Get account analytics

Return the analytics of your Talon.One account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
accountId	int32	The identifier of the account. Retrieve it via the List users in account endpoint in the `accountId` property.

Return type

AccountAnalytics

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAccountCollection

Collection GetAccountCollection(ctx, collectionId)

Get account-level collection

Retrieve a given account-level collection.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	int32	The ID of the collection. You can get it with the List collections in account endpoint.

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAchievement

Achievement GetAchievement(ctx, applicationId, campaignId, achievementId)

Get achievement

Get the details of a specific achievement.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
achievementId	int32	The ID of the achievement. You can get this ID with the List achievement endpoint.

Return type

Achievement

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAdditionalCost

AccountAdditionalCost GetAdditionalCost(ctx, additionalCostId)

Get additional cost

Returns the additional cost.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
additionalCostId	int32	The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in Account > Tools > Additional costs.

Return type

AccountAdditionalCost

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAdditionalCosts

InlineResponse20035 GetAdditionalCosts(ctx, optional)

List additional costs

Returns all the defined additional costs for the account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetAdditionalCostsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAdditionalCostsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.

Return type

InlineResponse20035

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplication

Application GetApplication(ctx, applicationId)

Get Application

Get the application specified by the ID.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.

Return type

Application

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationApiHealth

ApplicationApiHealth GetApplicationApiHealth(ctx, applicationId)

Get Application health

Display the health of the Application and show the last time the Application was used. You can also find this information in the Campaign Manager. In your Application, click Settings > Integration API Keys. See the docs.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.

Return type

ApplicationApiHealth

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationCustomer

ApplicationCustomer GetApplicationCustomer(ctx, applicationId, customerId)

Get application's customer

Retrieve the customers of the specified application.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
customerId	int32	The value of the `id` property of a customer profile. Get it with the List Application's customers endpoint.

Return type

ApplicationCustomer

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationCustomerFriends

InlineResponse20032 GetApplicationCustomerFriends(ctx, applicationId, integrationId, optional)

List friends referred by customer profile

List the friends referred by the specified customer profile in this Application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
integrationId	string	The Integration ID of the Advocate's Profile.
optional	*GetApplicationCustomerFriendsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationCustomerFriendsOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. |

Return type

InlineResponse20032

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationCustomers

InlineResponse20021 GetApplicationCustomers(ctx, applicationId, optional)

List application's customers

List all the customers of the specified application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*GetApplicationCustomersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationCustomersOpts struct

Name	Type	Description	Notes

integrationId | optional.| Filter results performing an exact matching against the profile integration identifier. | pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. |

Return type

InlineResponse20021

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationCustomersByAttributes

InlineResponse20022 GetApplicationCustomersByAttributes(ctx, applicationId, body, optional)

List application customers matching the given attributes

Get a list of the application customers matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
body	CustomerProfileSearchQuery	body
optional	*GetApplicationCustomersByAttributesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationCustomersByAttributesOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. |

Return type

InlineResponse20022

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

GetApplicationEventTypes

InlineResponse20028 GetApplicationEventTypes(ctx, applicationId, optional)

List Applications event types

Get all of the distinct values of the Event type property for events recorded in the application. See also: Track an event

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*GetApplicationEventTypesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationEventTypesOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. |

Return type

InlineResponse20028

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationEventsWithoutTotalCount

InlineResponse20027 GetApplicationEventsWithoutTotalCount(ctx, applicationId, optional)

List Applications events

Lists all events recorded for an application. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*GetApplicationEventsWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationEventsWithoutTotalCountOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20027

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationSession

ApplicationSession GetApplicationSession(ctx, applicationId, sessionId)

Get Application session

Get the details of the given session. You can list the sessions with the List Application sessions endpoint.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
sessionId	int32	The internal ID of the session. You can get the ID with the List Application sessions endpoint.

Return type

ApplicationSession

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplicationSessions

InlineResponse20026 GetApplicationSessions(ctx, applicationId, optional)

List Application sessions

List all the sessions of the specified Application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*GetApplicationSessionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationSessionsOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20026

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetApplications

InlineResponse2005 GetApplications(ctx, optional)

List Applications

List all applications in the current account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetApplicationsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetApplicationsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.

Return type

InlineResponse2005

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAttribute

Attribute GetAttribute(ctx, attributeId)

Get custom attribute

Retrieve the specified custom attribute.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
attributeId	int32	The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in Account > Tools > Attributes.

Return type

Attribute

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAttributes

InlineResponse20033 GetAttributes(ctx, optional)

List custom attributes

Return all the custom attributes for the account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetAttributesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAttributesOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
entity	optional.	Returned attributes will be filtered by supplied entity.

Return type

InlineResponse20033

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAudienceMemberships

InlineResponse20031 GetAudienceMemberships(ctx, audienceId, optional)

List audience members

Get a paginated list of the customer profiles in a given audience. A maximum of 1000 customer profiles per page is allowed.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
audienceId	int32	The ID of the audience.
optional	*GetAudienceMembershipsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAudienceMembershipsOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20031

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAudiences

InlineResponse20029 GetAudiences(ctx, optional)

List audiences

Get all audiences created in the account. To create an audience, use Create audience.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetAudiencesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAudiencesOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
withTotalResultSize	optional.	When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.

Return type

InlineResponse20029

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetAudiencesAnalytics

InlineResponse20030 GetAudiencesAnalytics(ctx, audienceIds, optional)

List audience analytics

Get a list of audience IDs and their member count.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
audienceIds	string	The IDs of one or more audiences, separated by commas, by which to filter results.
optional	*GetAudiencesAnalyticsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAudiencesAnalyticsOpts struct

Name	Type	Description	Notes

sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. |

Return type

InlineResponse20030

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCampaign

Campaign GetCampaign(ctx, applicationId, campaignId)

Get campaign

Retrieve the given campaign.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.

Return type

Campaign

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCampaignAnalytics

InlineResponse20020 GetCampaignAnalytics(ctx, applicationId, campaignId, rangeStart, rangeEnd, optional)

Get analytics of campaigns

Retrieve statistical data about the performance of the given campaign.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
rangeStart	time.Time	Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
rangeEnd	time.Time	Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
optional	*GetCampaignAnalyticsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCampaignAnalyticsOpts struct

Name	Type	Description	Notes

granularity | optional.| The time interval between the results in the returned time-series. |

Return type

InlineResponse20020

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCampaignByAttributes

InlineResponse2006 GetCampaignByAttributes(ctx, applicationId, body, optional)

List campaigns that match the given attributes

Get a list of all the campaigns that match a set of attributes.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
body	CampaignSearch	body
optional	*GetCampaignByAttributesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCampaignByAttributesOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | campaignState | optional.| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. |

Return type

InlineResponse2006

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

GetCampaignGroup

CampaignGroup GetCampaignGroup(ctx, campaignGroupId)

Get campaign access group

Get a campaign access group specified by its ID.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
campaignGroupId	int32	The ID of the campaign access group.

Return type

CampaignGroup

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCampaignGroups

InlineResponse20011 GetCampaignGroups(ctx, optional)

List campaign access groups

List the campaign access groups in the current account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetCampaignGroupsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCampaignGroupsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.

Return type

InlineResponse20011

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCampaignTemplates

InlineResponse20012 GetCampaignTemplates(ctx, optional)

List campaign templates

Retrieve a list of campaign templates.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetCampaignTemplatesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCampaignTemplatesOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
state	optional.	Filter results by the state of the campaign template.
name	optional.	Filter results performing case-insensitive matching against the name of the campaign template.
tags	optional.	Filter results performing case-insensitive matching against the tags of the campaign template. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values.
userId	optional.	Filter results by user ID.

Return type

InlineResponse20012

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCampaigns

InlineResponse2006 GetCampaigns(ctx, applicationId, optional)

List campaigns

List the campaigns of the specified application that match your filter criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*GetCampaignsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCampaignsOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | campaignState | optional.| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. | name | optional.| Filter results performing case-insensitive matching against the name of the campaign. | tags | optional.| Filter results performing case-insensitive matching against the tags of the campaign. When used in conjunction with the "name" query parameter, a logical OR will be performed to search both tags and name for the provided values | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the campaign creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | campaignGroupId | optional.| Filter results to campaigns owned by the specified campaign access group ID. | templateId | optional.| The ID of the campaign template this campaign was created from. | storeId | optional.| Filter results to campaigns linked to the specified store ID. |

Return type

InlineResponse2006

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetChanges

InlineResponse20041 GetChanges(ctx, optional)

Get audit logs for an account

Retrieve the audit logs displayed in Accounts > Audit logs.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetChangesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetChangesOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
applicationId	optional.	Filter results by Application ID.
entityPath	optional.	Filter results on a case insensitive matching of the url path of the entity
userId	optional.	Filter results by user ID.
createdBefore	optional.	Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
createdAfter	optional.	Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the change creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally.
withTotalResultSize	optional.	When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
managementKeyId	optional.	Filter results that match the given management key ID.
includeOld	optional.	When this flag is set to false, the state without the change will not be returned. The default value is true.

Return type

InlineResponse20041

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCollection

Collection GetCollection(ctx, applicationId, campaignId, collectionId)

Get campaign-level collection

Retrieve a given campaign-level collection.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
collectionId	int32	The ID of the collection. You can get it with the List collections in Application endpoint.

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCollectionItems

InlineResponse20018 GetCollectionItems(ctx, collectionId, optional)

Get collection items

Retrieve items from a given collection. You can retrieve items from both account-level collections and campaign-level collections using this endpoint.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	int32	The ID of the collection. You can get it with the List collections in account endpoint.
optional	*GetCollectionItemsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCollectionItemsOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20018

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCouponsWithoutTotalCount

InlineResponse2009 GetCouponsWithoutTotalCount(ctx, applicationId, campaignId, optional)

List coupons

List all the coupons matching the specified criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*GetCouponsWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCouponsWithoutTotalCountOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | value | optional.| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | usable | optional.| Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. | redeemed | optional.| - `true`: only coupons where `usageCounter > 0` will be returned. - `false`: only coupons where `usageCounter = 0` will be returned. - This field cannot be used in conjunction with the `usable` query parameter. | referralId | optional.| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | recipientIntegrationId | optional.| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | batchId | optional.| Filter results by batches of coupons | exactMatch | optional.| Filter results to an exact case-insensitive matching against the coupon code. | [default to false] expiresBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | expiresAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon expiration date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | startsBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | startsAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon start date timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valuesOnly | optional.| Filter results to only return the coupon codes (`value` column) without the associated coupon data. | [default to false]

Return type

InlineResponse2009

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomerActivityReport

CustomerActivityReport GetCustomerActivityReport(ctx, rangeStart, rangeEnd, applicationId, customerId, optional)

Get customer's activity report

Fetch the summary report of a given customer in the given application, in a time range.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
rangeStart	time.Time	Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
rangeEnd	time.Time	Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
customerId	int32	The value of the `id` property of a customer profile. Get it with the List Application's customers endpoint.
optional	*GetCustomerActivityReportOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomerActivityReportOpts struct

Name	Type	Description	Notes

Return type

CustomerActivityReport

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomerActivityReportsWithoutTotalCount

InlineResponse20025 GetCustomerActivityReportsWithoutTotalCount(ctx, rangeStart, rangeEnd, applicationId, optional)

Get Activity Reports for Application Customers

Fetch summary reports for all application customers based on a time range. Instead of having the total number of results in the response, this endpoint only mentions whether there are more results.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
rangeStart	time.Time	Only return results from after this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
rangeEnd	time.Time	Only return results from before this timestamp. Note: - This must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*GetCustomerActivityReportsWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomerActivityReportsWithoutTotalCountOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20025

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomerAnalytics

CustomerAnalytics GetCustomerAnalytics(ctx, applicationId, customerId, optional)

Get customer's analytics report

Fetch analytics for a given customer in the given application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
customerId	int32	The value of the `id` property of a customer profile. Get it with the List Application's customers endpoint.
optional	*GetCustomerAnalyticsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomerAnalyticsOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. |

Return type

CustomerAnalytics

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomerProfile

CustomerProfile GetCustomerProfile(ctx, customerId)

Get customer profile

Return the details of the specified customer profile. <div class="redoc-section"> <p class="title">Performance tips

You can retrieve the same information via the Integration API, which can save you extra API requests. consider these options: - Request the customer profile to be part of the response content using Update Customer Session. - Send an empty update with the Update Customer Profile endpoint with runRuleEngine=false.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
customerId	int32	The value of the `id` property of a customer profile. Get it with the List Application's customers endpoint.

Return type

CustomerProfile

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomerProfileAchievementProgress

InlineResponse20046 GetCustomerProfileAchievementProgress(ctx, applicationId, integrationId, optional)

List customer achievements

For the given customer profile, list all the achievements that match your filter criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
integrationId	string	The identifier of the profile.
optional	*GetCustomerProfileAchievementProgressOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomerProfileAchievementProgressOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20046

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomerProfiles

InlineResponse20024 GetCustomerProfiles(ctx, optional)

List customer profiles

List all customer profiles.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetCustomerProfilesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomerProfilesOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sandbox	optional.	Indicates whether you are pointing to a sandbox or live customer.	[default to false]

Return type

InlineResponse20024

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetCustomersByAttributes

InlineResponse20023 GetCustomersByAttributes(ctx, body, optional)

List customer profiles matching the given attributes

Get a list of the customer profiles matching the provided criteria. The match is successful if all the attributes of the request are found in a profile, even if the profile has more attributes that are not present on the request.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	CustomerProfileSearchQuery	body
optional	*GetCustomersByAttributesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetCustomersByAttributesOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20023

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

GetEventTypes

InlineResponse20039 GetEventTypes(ctx, optional)

List event types

Fetch all event type definitions for your account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetEventTypesOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetEventTypesOpts struct

Name	Type	Description	Notes
name	optional.	Filter results to event types with the given name. This parameter implies `includeOldVersions`.
includeOldVersions	optional.	Include all versions of every event type.	[default to false]
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.

Return type

InlineResponse20039

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetExports

InlineResponse20042 GetExports(ctx, optional)

Get exports

List all past exports

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetExportsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetExportsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
applicationId	optional.	Filter results by Application ID.
campaignId	optional.	Filter by the campaign ID on which the limit counters are used.
entity	optional.	The name of the entity type that was exported.

Return type

InlineResponse20042

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyCard

LoyaltyCard GetLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId)

Get loyalty card

Get the given loyalty card.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.

Return type

LoyaltyCard

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyCardTransactionLogs

InlineResponse20016 GetLoyaltyCardTransactionLogs(ctx, loyaltyProgramId, loyaltyCardId, optional)

List card's transactions

Retrieve the transaction logs for the given loyalty card within the specified card-based loyalty program with filtering options applied. If no filtering options are applied, the last 50 loyalty transactions for the given loyalty card are returned.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
optional	*GetLoyaltyCardTransactionLogsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetLoyaltyCardTransactionLogsOpts struct

Name	Type	Description	Notes

startDate | optional.| Date and time from which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | endDate | optional.| Date and time by which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | subledgerId | optional.| The ID of the subledger by which we filter the data. |

Return type

InlineResponse20016

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyCards

InlineResponse20015 GetLoyaltyCards(ctx, loyaltyProgramId, optional)

List loyalty cards

For the given card-based loyalty program, list the loyalty cards that match your filter criteria.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
optional	*GetLoyaltyCardsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetLoyaltyCardsOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20015

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyPoints

LoyaltyLedger GetLoyaltyPoints(ctx, loyaltyProgramId, integrationId)

Get customer's full loyalty ledger

Get the loyalty ledger for this profile integration ID. To get the integrationId of the profile from a sessionId, use the Update customer session endpoint. Important: To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's Get customer's loyalty logs.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	string	The identifier for the loyalty program.
integrationId	string	The identifier of the profile.

Return type

LoyaltyLedger

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyProgram

LoyaltyProgram GetLoyaltyProgram(ctx, loyaltyProgramId)

Get loyalty program

Get the specified loyalty program. To list all loyalty programs in your Application, use List loyalty programs. To list the loyalty programs that a customer profile is part of, use the List customer data

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the loyalty program. You can get the ID with the List loyalty programs endpoint.

Return type

LoyaltyProgram

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyProgramTransactions

InlineResponse20014 GetLoyaltyProgramTransactions(ctx, loyaltyProgramId, optional)

List loyalty program transactions

Retrieve loyalty program transaction logs in a given loyalty program with filtering options applied. Manual and imported transactions are also included. Note: If no filters are applied, the last 50 loyalty transactions for the given loyalty program are returned. Important: To get loyalty transaction logs for a given Integration ID in a loyalty program, we recommend using the Integration API's Get customer's loyalty logs.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the loyalty program. You can get the ID with the List loyalty programs endpoint.
optional	*GetLoyaltyProgramTransactionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetLoyaltyProgramTransactionsOpts struct

Name	Type	Description	Notes

loyaltyTransactionType | optional.| Filter results by loyalty transaction type: - `manual`: Loyalty transaction that was done manually. - `session`: Loyalty transaction that resulted from a customer session. - `import`: Loyalty transaction that was imported from a CSV file. | subledgerId | optional.| The ID of the subledger by which we filter the data. | startDate | optional.| Date and time from which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | endDate | optional.| Date and time by which results are returned. Results are filtered by transaction creation date. Note: - It must be an RFC3339 timestamp string. - You can include a time component in your string, for example, `T23:59:59` to specify the end of the day. The time zone setting considered is `UTC`. If you do not include a time component, a default time value of `T00:00:00` (midnight) in `UTC` is considered. | pageSize | optional.| The number of items in the response. | [default to 50] skip | optional.| The number of items to skip when paging through large result sets. |

Return type

InlineResponse20014

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyPrograms

InlineResponse20013 GetLoyaltyPrograms(ctx, )

List loyalty programs

List the loyalty programs of the account.

Required Parameters

This endpoint does not need any parameter.

Return type

InlineResponse20013

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetLoyaltyStatistics

LoyaltyDashboardData GetLoyaltyStatistics(ctx, loyaltyProgramId)

Get loyalty program statistics

Retrieve the statistics of the specified loyalty program such as the total active points, pending points, spent points, and expired points. Important: The returned data does not include the current day. All statistics are updated daily at 11:59 PM in the loyalty program time zone.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the loyalty program. You can get the ID with the List loyalty programs endpoint.

Return type

LoyaltyDashboardData

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetReferralsWithoutTotalCount

InlineResponse20010 GetReferralsWithoutTotalCount(ctx, applicationId, campaignId, optional)

List referrals

List all referrals of the specified campaign.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*GetReferralsWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetReferralsWithoutTotalCountOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | code | optional.| Filter results performing case-insensitive matching against the referral code. Both the code and the query are folded to remove all non-alpha-numeric characters. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the referral creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| Either "expired", "validNow", or "validFuture". The first option matches referrals in which the expiration date is set and in the past. The second matches referrals in which start date is null or in the past and expiration date is null or in the future, the third matches referrals in which start date is set and in the future. | usable | optional.| Either "true" or "false". If "true", only referrals where `usageCounter < usageLimit` will be returned, "false" will return only referrals where `usageCounter >= usageLimit`. | advocate | optional.| Filter results by match with a profile ID specified in the referral's AdvocateProfileIntegrationId field. |

Return type

InlineResponse20010

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetRoleV2

RoleV2 GetRoleV2(ctx, roleId)

Get role

Get the details of a specific role. To see all the roles, use the List roles endpoint.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleId	int32	The ID of role. Note: To find the ID of a role, use the List roles endpoint.

Return type

RoleV2

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetRuleset

Ruleset GetRuleset(ctx, applicationId, campaignId, rulesetId)

Get ruleset

Retrieve the specified ruleset.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
rulesetId	int32	The ID of the ruleset.

Return type

Ruleset

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetRulesets

InlineResponse2007 GetRulesets(ctx, applicationId, campaignId, optional)

List campaign rulesets

List all rulesets of this campaign. A ruleset is a revision of the rules of a campaign. Important: The response also includes deleted rules. You should only consider the latest revision of the returned rulesets.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*GetRulesetsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetRulesetsOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. |

Return type

InlineResponse2007

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetStore

Store GetStore(ctx, applicationId, storeId)

Get store

Get store details for a specific store ID.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
storeId	string	The ID of the store. You can get this ID with the List stores endpoint.

Return type

Store

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetUser

User GetUser(ctx, userId)

Get user

Retrieve the data (including an invitation code) for a user. Non-admin users can only get their own profile.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.

Return type

User

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetUsers

InlineResponse20040 GetUsers(ctx, optional)

List users in account

Retrieve all users in your account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetUsersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetUsersOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.

Return type

InlineResponse20040

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetWebhook

Webhook GetWebhook(ctx, webhookId)

Get webhook

Returns a webhook by its id.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
webhookId	int32	The ID of the webhook. You can find the ID in the Campaign Manager's URL when you display the details of the webhook in Account > Webhooks.

Return type

Webhook

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetWebhookActivationLogs

InlineResponse20037 GetWebhookActivationLogs(ctx, optional)

List webhook activation log entries

Webhook activation log entries are created as soon as an integration request triggers a webhook effect. See the docs.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetWebhookActivationLogsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetWebhookActivationLogsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
integrationRequestUuid	optional.	Filter results by integration request UUID.
webhookId	optional.	Filter results by webhook id.
applicationId	optional.	Filter results by Application ID.
campaignId	optional.	Filter results by campaign ID.
createdBefore	optional.	Only return events created before this date. You can use any time zone setting. Talon.One will convert to UTC internally.
createdAfter	optional.	Only return events created after this date. You can use any time zone setting. Talon.One will convert to UTC internally.

Return type

InlineResponse20037

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetWebhookLogs

InlineResponse20038 GetWebhookLogs(ctx, optional)

List webhook log entries

Retrieve all webhook log entries.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetWebhookLogsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetWebhookLogsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
status	optional.	Filter results by HTTP status codes.
webhookId	optional.	Filter results by webhook id.
applicationId	optional.	Filter results by Application ID.
campaignId	optional.	Filter results by campaign ID.
requestUuid	optional.	Filter results by request UUID.
createdBefore	optional.	Filter results where request and response times to return entries before parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.
createdAfter	optional.	Filter results where request and response times to return entries after parameter value, expected to be an RFC3339 timestamp string. You can use any time zone setting. Talon.One will convert to UTC internally.

Return type

InlineResponse20038

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

GetWebhooks

InlineResponse20036 GetWebhooks(ctx, optional)

List webhooks

List all webhooks.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*GetWebhooksOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetWebhooksOpts struct

Name	Type	Description	Notes
applicationIds	optional.	Checks if the given catalog or its attributes are referenced in the specified Application ID. Note: If no Application ID is provided, we check for all connected Applications.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
creationType	optional.	Filter results by creation type.
visibility	optional.	Filter results by visibility.
outgoingIntegrationsTypeId	optional.	Filter results by outgoing integration type ID.
title	optional.	Filter results performing case-insensitive matching against the webhook title.

Return type

InlineResponse20036

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ImportAccountCollection

Import ImportAccountCollection(ctx, collectionId, optional)

Import data into existing account-level collection

Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import replaces the initial content of the collection. The CSV file must only contain the following column: - item: the values in your collection. A collection is limited to 500,000 items. Example: item Addidas Nike Asics Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	int32	The ID of the collection. You can get it with the List collections in account endpoint.
optional	*ImportAccountCollectionOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportAccountCollectionOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportAllowedList

Import ImportAllowedList(ctx, attributeId, optional)

Import allowed values for attribute

Upload a CSV file containing a list of picklist values for the specified attribute. The file should be sent as multipart data. The import replaces the previous list of allowed values for this attribute, if any. The CSV file must only contain the following column: - item (required): the values in your allowed list, for example a list of SKU's. An allowed list is limited to 500,000 items. Example: text item CS-VG-04032021-UP-50D-10 CS-DV-04042021-UP-49D-12 CS-DG-02082021-UP-50G-07

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
attributeId	int32	The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in Account > Tools > Attributes.
optional	*ImportAllowedListOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportAllowedListOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportAudiencesMemberships

Import ImportAudiencesMemberships(ctx, audienceId, optional)

Import audience members

Upload a CSV file containing the integration IDs of the members you want to add to an audience. The file should be sent as multipart data and should contain only the following column (required): - profileintegrationid: The integration ID of the customer profile. The import replaces the previous list of audience members. Note: We recommend limiting your file size to 500MB. Example: text profileintegrationid charles alexa

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
audienceId	int32	The ID of the audience.
optional	*ImportAudiencesMembershipsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportAudiencesMembershipsOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportCampaignStores

Import ImportCampaignStores(ctx, applicationId, campaignId, optional)

Import stores

Upload a CSV file containing the stores you want to link to a specific campaign. Send the file as multipart data. The CSV file must only contain the following column: - store_integration_id: The identifier of the store. The import replaces the previous list of stores linked to the campaign.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*ImportCampaignStoresOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportCampaignStoresOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportCollection

Import ImportCollection(ctx, applicationId, campaignId, collectionId, optional)

Import data into existing campaign-level collection

Upload a CSV file containing the collection of string values that should be attached as payload for collection. The file should be sent as multipart data. The import replaces the initial content of the collection. The CSV file must only contain the following column: - item: the values in your collection. A collection is limited to 500,000 items. Example: item Addidas Nike Asics Note: Before sending a request to this endpoint, ensure the data in the CSV to import is different from the data currently stored in the collection.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
collectionId	int32	The ID of the collection. You can get it with the List collections in Application endpoint.
optional	*ImportCollectionOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportCollectionOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportCoupons

Import ImportCoupons(ctx, applicationId, campaignId, optional)

Import coupons

Upload a CSV file containing the coupons that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - value (required): The coupon code. - expirydate: The end date in RFC3339 of the code redemption period. - startdate: The start date in RFC3339 of the code redemption period. - recipientintegrationid: The integration ID of the recipient of the coupon. Only the customer with this integration ID can redeem this code. Available only for personal codes. - limitval: The maximum number of redemptions of this code. For unlimited redemptions, use 0. Defaults to 1 when not provided. - discountlimit: The total discount value that the code can give. This is typically used to represent a gift card value. - attributes: A JSON object describing custom coupon attribute names and their values, enclosed with double quotation marks. For example, if you created a custom attribute called category associated with the coupon entity, the object in the CSV file, when opened in a text editor, must be: \"{\"category\": \"10_off\"}\". You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. Example: text \"value\",\"expirydate\",\"startdate\",\"recipientintegrationid\",\"limitval\",\"attributes\",\"discountlimit\" COUP1,2018-07-01T04:00:00Z,2018-05-01T04:00:00Z,cust123,1,\"{\"\"Category\"\": \"\"10_off\"\"}\",2.4 Once imported, you can find the batchId in the Campaign Manager or by using List coupons.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*ImportCouponsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportCouponsOpts struct

Name	Type	Description	Notes

skipDuplicates | optional.| An indicator of whether to skip duplicate coupon values instead of causing an error. Duplicate values are ignored when `skipDuplicates=true`. | upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportLoyaltyCards

Import ImportLoyaltyCards(ctx, loyaltyProgramId, optional)

Import loyalty cards

Upload a CSV file containing the loyalty cards that you want to use in your card-based loyalty program. Send the file as multipart data. It contains the following columns for each card: - identifier (required): The alphanumeric identifier of the loyalty card. - state (required): The state of the loyalty card. It can be active or inactive. - customerprofileids (optional): An array of strings representing the identifiers of the customer profiles linked to the loyalty card. The identifiers should be separated with a semicolon (;). Note: We recommend limiting your file size to 500MB. Example: csv identifier,state,customerprofileids 123-456-789AT,active,Alexa001;UserA

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
optional	*ImportLoyaltyCardsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportLoyaltyCardsOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportLoyaltyCustomersTiers

Import ImportLoyaltyCustomersTiers(ctx, loyaltyProgramId, optional)

Import customers into loyalty tiers

Upload a CSV file containing existing customers to be assigned to existing tiers. Send the file as multipart data. Important: This endpoint only works with loyalty programs with advanced tiers (with expiration and downgrade policy) feature enabled. The CSV file should contain the following columns: - subledgerid (optional): The ID of the subledger. If this field is empty, the main ledger will be used. - customerprofileid: The integration ID of the customer profile to whom the tier should be assigned. - tiername: The name of an existing tier to assign to the customer. - expirydate: The expiration date of the tier when the tier is reevaluated. It should be a future date. About customer assignment to a tier: - If the customer isn't already in a tier, the customer is assigned to the specified tier during the tier import. - If the customer is already in the tier that's specified in the CSV file, only the expiration date is updated. Note: We recommend not using this endpoint to update the tier of a customer. To update a customer's tier, you can add or deduct their loyalty points. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: We recommend limiting your file size to 500MB. Example: csv subledgerid,customerprofileid,tiername,expirydate SUB1,alexa,Gold,2024-03-21T07:32:14Z ,george,Silver,2025-04-16T21:12:37Z SUB2,avocado,Bronze,2026-05-03T11:47:01Z

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the loyalty program. You can get the ID with the List loyalty programs endpoint.
optional	*ImportLoyaltyCustomersTiersOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportLoyaltyCustomersTiersOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportLoyaltyPoints

Import ImportLoyaltyPoints(ctx, loyaltyProgramId, optional)

Import loyalty points

Upload a CSV file containing the loyalty points you want to import into a given loyalty program. Send the file as multipart data. Depending on the type of loyalty program, you can import points into a given customer profile or loyalty card. The CSV file contains the following columns: - customerprofileid (optional): For profile-based loyalty programs, the integration ID of the customer profile where the loyalty points are imported. Note: If the customer profile does not exist, it will be created. The profile will not be visible in any Application until a session or profile update is received for that profile. - identifier (optional): For card-based loyalty programs, the identifier of the loyalty card where the loyalty points are imported. - amount: The amount of points to award to the customer profile. - startdate (optional): The earliest date when the points can be redeemed. The points are active from this date until the expiration date. Note: It must be an RFC3339 timestamp string or string immediate. Empty or missing values are considered immediate. - expirydate (optional): The latest date when the points can be redeemed. The points are expired after this date. Note: It must be an RFC3339 timestamp string or string unlimited. Empty or missing values are considered unlimited. - subledgerid (optional): The ID of the subledger that should received the points. - reason (optional): The reason why these points are awarded. You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Note: For existing customer profiles and loyalty cards, the imported points are added to any previous active or pending points, depending on the value provided for startdate. If startdate matches the current date, the imported points are active. If it is later, the points are pending until the date provided for startdate is reached. Note: We recommend limiting your file size to 500MB. Example for profile-based programs: text customerprofileid,amount,startdate,expirydate,subledgerid,reason URNGV8294NV,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement Example for card-based programs: text identifier,amount,startdate,expirydate,subledgerid,reason summer-loyalty-card-0543,100,2009-11-10T23:00:00Z,2009-11-11T23:00:00Z,subledger1,appeasement

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the loyalty program. You can get the ID with the List loyalty programs endpoint.
optional	*ImportLoyaltyPointsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportLoyaltyPointsOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportPoolGiveaways

Import ImportPoolGiveaways(ctx, poolId, optional)

Import giveaway codes into a giveaway pool

Upload a CSV file containing the giveaway codes that should be created. Send the file as multipart data. The CSV file contains the following columns: - code (required): The code of your giveaway, for instance, a gift card redemption code. - startdate: The start date in RFC3339 of the code redemption period. - enddate: The last date in RFC3339 of the code redemption period. - attributes: A JSON object describing custom giveaway attribute names and their values, enclosed with double quotation marks. For example, if you created a custom attribute called provider associated with the giveaway entity, the object in the CSV file, when opened in a text editor, must be: \"{\"provider\": \"myPartnerCompany\"}\". The startdate and enddate have nothing to do with the validity of the codes. They are only used by the Rule Engine to award the codes or not. You can use the time zone setting of your choice. The values are converted to UTC internally by Talon.One. Note: - We recommend limiting your file size to 500MB. - You can import the same code multiple times. Duplicate codes are treated and distributed to customers as unique codes. Example: text code,startdate,enddate,attributes GIVEAWAY1,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY2,2020-11-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Amazon\"\"}\" GIVEAWAY3,2021-01-10T23:00:00Z,2022-11-11T23:00:00Z,\"{\"\"provider\"\": \"\"Aliexpress\"\"}\"

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
poolId	int32	The ID of the pool. You can find it in the Campaign Manager, in the Giveaways section.
optional	*ImportPoolGiveawaysOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportPoolGiveawaysOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

ImportReferrals

Import ImportReferrals(ctx, applicationId, campaignId, optional)

Import referrals

Upload a CSV file containing the referrals that should be created. The file should be sent as multipart data. The CSV file contains the following columns: - code (required): The referral code. - advocateprofileintegrationid (required): The profile ID of the advocate. - startdate: The start date in RFC3339 of the code redemption period. - expirydate: The end date in RFC3339 of the code redemption period. - limitval: The maximum number of redemptions of this code. Defaults to 1 when left blank. - attributes: A JSON object describing custom referral attribute names and their values, enclosed with double quotation marks. For example, if you created a custom attribute called category associated with the referral entity, the object in the CSV file, when opened in a text editor, must be: \"{\"category\": \"10_off\"}\". You can use the time zone of your choice. It is converted to UTC internally by Talon.One. Important: When you import a CSV file with referrals, a customer profile is not automatically created for each advocateprofileintegrationid column value. Use the Update customer profile endpoint or the Update multiple customer profiles endpoint to create the customer profiles. Note: We recommend limiting your file size to 500MB. Example: text code,startdate,expirydate,advocateprofileintegrationid,limitval,attributes REFERRAL_CODE1,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid_4,1,\"{\"\"my_attribute\"\": \"\"10_off\"\"}\" REFERRAL_CODE2,2020-11-10T23:00:00Z,2021-11-11T23:00:00Z,integid1,1,\"{\"\"my_attribute\"\": \"\"20_off\"\"}\"

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*ImportReferralsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportReferralsOpts struct

Name	Type	Description	Notes

upFile | optional.| The file containing the data that is being imported. |

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

InviteUserExternal

InviteUserExternal(ctx, body)

Invite user from identity provider

Invite a user from an external identity provider to Talon.One by sending an invitation to their email address.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewExternalInvitation	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: Not defined

ListAccountCollections

InlineResponse20017 ListAccountCollections(ctx, optional)

List collections in account

List account-level collections in the account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
optional	*ListAccountCollectionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListAccountCollectionsOpts struct

Name	Type	Description	Notes
pageSize	optional.	The number of items in the response.	[default to 1000]
skip	optional.	The number of items to skip when paging through large result sets.
sort	optional.	The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields.
withTotalResultSize	optional.	When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query.
name	optional.	Filter by collection name.

Return type

InlineResponse20017

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListAchievements

InlineResponse20045 ListAchievements(ctx, applicationId, campaignId, optional)

List achievements

List all the achievements for a specific campaign.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*ListAchievementsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListAchievementsOpts struct

Name	Type	Description	Notes

Return type

InlineResponse20045

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListAllRolesV2

InlineResponse20043 ListAllRolesV2(ctx, )

List roles

List all roles.

Required Parameters

This endpoint does not need any parameter.

Return type

InlineResponse20043

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListCatalogItems

InlineResponse20034 ListCatalogItems(ctx, catalogId, optional)

List items in a catalog

Return a paginated list of cart items in the given catalog.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
catalogId	int32	The ID of the catalog. You can find the ID in the Campaign Manager in Account > Tools > Cart item catalogs.
optional	*ListCatalogItemsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListCatalogItemsOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | sku | optional.Interface of []string| Filter results by one or more SKUs. Must be exact match. | productNames | optional.Interface of []string| Filter results by one or more product names. Must be exact match. |

Return type

InlineResponse20034

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListCollections

InlineResponse20017 ListCollections(ctx, applicationId, campaignId, optional)

List collections in campaign

List collections in a given campaign.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
optional	*ListCollectionsOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListCollectionsOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | name | optional.| Filter by collection name. |

Return type

InlineResponse20017

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListCollectionsInApplication

InlineResponse20017 ListCollectionsInApplication(ctx, applicationId, optional)

List collections in Application

List campaign-level collections from all campaigns in a given Application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*ListCollectionsInApplicationOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListCollectionsInApplicationOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | name | optional.| Filter by collection name. |

Return type

InlineResponse20017

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ListStores

InlineResponse20044 ListStores(ctx, applicationId, optional)

List stores

List all stores for a specific Application.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
optional	*ListStoresOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListStoresOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | withTotalResultSize | optional.| When this flag is set, the result includes the total size of the result, across all pages. This might decrease performance on large data sets. - When `true`: `hasMore` is true when there is a next page. `totalResultSize` is always zero. - When `false`: `hasMore` is always false. `totalResultSize` contains the total number of results for this query. | campaignId | optional.| Filter results by campaign ID. | name | optional.| The name of the store. | integrationId | optional.| The integration ID of the store. | query | optional.| Filter results by `name` or `integrationId`. |

Return type

InlineResponse20044

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

NotificationActivation

NotificationActivation(ctx, notificationId, body)

Activate or deactivate notification

Activate or deactivate the given notification. When enabled is false, updates will no longer be sent for the given notification.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
notificationId	int32	The ID of the notification. Get it with the appropriate List notifications endpoint.
body	NotificationActivation	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: Not defined

OktaEventHandlerChallenge

OktaEventHandlerChallenge(ctx, )

Validate Okta API ownership

Validate the ownership of the API through a challenge-response mechanism. This challenger endpoint is used by Okta to confirm that communication between Talon.One and Okta is correctly configured and accessible for provisioning and deprovisioning of Talon.One users, and that only Talon.One can receive and respond to events from Okta.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

PostAddedDeductedPointsNotification

BaseNotification PostAddedDeductedPointsNotification(ctx, loyaltyProgramId, body)

Create notification about added or deducted loyalty points

Create a notification about added or deducted loyalty points in a given profile-based loyalty program. A notification for added or deducted loyalty points is different from regular webhooks in that it is loyalty program-scoped and has a predefined payload. For more information, see Managing loyalty notifications.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the profile-based loyalty program. You can get the ID with the List loyalty programs endpoint.
body	NewBaseNotification	body

Return type

BaseNotification

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

PostCatalogsStrikethroughNotification

BaseNotification PostCatalogsStrikethroughNotification(ctx, applicationId, body)

Create strikethrough notification

Create a notification for the in the given Application. For more information, see Managing notifications. See the payload you will receive.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
body	NewBaseNotification	body

Return type

BaseNotification

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

PostPendingPointsNotification

BaseNotification PostPendingPointsNotification(ctx, loyaltyProgramId, body)

Create notification about pending loyalty points

Create a notification about pending loyalty points for a given profile-based loyalty program. For more information, see Managing loyalty notifications.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the profile-based loyalty program. You can get the ID with the List loyalty programs endpoint.
body	NewBaseNotification	body

Return type

BaseNotification

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

RemoveLoyaltyPoints

RemoveLoyaltyPoints(ctx, loyaltyProgramId, integrationId, body)

Deduct points from customer profile

Deduct points from the specified loyalty program and specified customer profile. Important: - Only active points can be deducted. - Only pending points are rolled back when a session is cancelled or reopened. To get the integrationId of the profile from a sessionId, use the Update customer session endpoint.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	string	The identifier for the loyalty program.
integrationId	string	The identifier of the profile.
body	DeductLoyaltyPoints	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

ResetPassword

NewPassword ResetPassword(ctx, body)

Reset password

Consumes the supplied password reset token and updates the password for the associated account.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	NewPassword	body

Return type

NewPassword

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

ScimCreateUser

ScimUser ScimCreateUser(ctx, body)

Create SCIM user

Create a new Talon.One user using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
body	ScimNewUser	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

ScimDeleteUser

ScimDeleteUser(ctx, userId)

Delete SCIM user

Delete a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: Not defined

ScimGetResourceTypes

ScimResourceTypesListResponse ScimGetResourceTypes(ctx, )

List supported SCIM resource types

Retrieve a list of resource types supported by the SCIM provisioning protocol. Resource types define the various kinds of resources that can be managed via the SCIM API, such as users, groups, or custom-defined resources.

Required Parameters

This endpoint does not need any parameter.

Return type

ScimResourceTypesListResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ScimGetSchemas

ScimSchemasListResponse ScimGetSchemas(ctx, )

List supported SCIM schemas

Retrieve a list of schemas supported by the SCIM provisioning protocol. Schemas define the structure and attributes of the different resources that can be managed via the SCIM API, such as users, groups, and any custom-defined resources.

Required Parameters

This endpoint does not need any parameter.

Return type

ScimSchemasListResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ScimGetServiceProviderConfig

ScimServiceProviderConfigResponse ScimGetServiceProviderConfig(ctx, )

Get SCIM service provider configuration

Retrieve the configuration settings of the SCIM service provider. It provides details about the features and capabilities supported by the SCIM API, such as the different operation settings.

Required Parameters

This endpoint does not need any parameter.

Return type

ScimServiceProviderConfigResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ScimGetUser

ScimUser ScimGetUser(ctx, userId)

Get SCIM user

Retrieve data for a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ScimGetUsers

ScimUsersListResponse ScimGetUsers(ctx, )

List SCIM users

Retrieve a paginated list of users that have been provisioned using the SCIM protocol with an identity provider, for example, Microsoft Entra ID.

Required Parameters

This endpoint does not need any parameter.

Return type

ScimUsersListResponse

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

ScimPatchUser

ScimUser ScimPatchUser(ctx, userId, body)

Update SCIM user attributes

Update certain attributes of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint allows for selective adding, removing, or replacing specific attributes while leaving other attributes unchanged.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.
body	ScimPatchRequest	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

ScimReplaceUserAttributes

ScimUser ScimReplaceUserAttributes(ctx, userId, body)

Update SCIM user

Update the details of a specific Talon.One user created using the SCIM provisioning protocol with an identity provider, for example, Microsoft Entra ID. This endpoint replaces all attributes of the specific user with the attributes provided in the request payload.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.
body	ScimNewUser	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

SearchCouponsAdvancedApplicationWideWithoutTotalCount

InlineResponse2009 SearchCouponsAdvancedApplicationWideWithoutTotalCount(ctx, applicationId, body, optional)

List coupons that match the given attributes (without total count)

List the coupons whose attributes match the query criteria in all the campaigns of the given Application. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. Note: The total count is not included in the response.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
body	map[string]interface{}	body
optional	*SearchCouponsAdvancedApplicationWideWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SearchCouponsAdvancedApplicationWideWithoutTotalCountOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | value | optional.| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | usable | optional.| Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. | referralId | optional.| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | recipientIntegrationId | optional.| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | batchId | optional.| Filter results by batches of coupons | exactMatch | optional.| Filter results to an exact case-insensitive matching against the coupon code. | [default to false] campaignState | optional.| Filter results by the state of the campaign. - `enabled`: Campaigns that are scheduled, running (activated), or expired. - `running`: Campaigns that are running (activated). - `disabled`: Campaigns that are disabled. - `expired`: Campaigns that are expired. - `archived`: Campaigns that are archived. |

Return type

InlineResponse2009

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

SearchCouponsAdvancedWithoutTotalCount

InlineResponse2009 SearchCouponsAdvancedWithoutTotalCount(ctx, applicationId, campaignId, body, optional)

List coupons that match the given attributes in campaign (without total count)

List the coupons whose attributes match the query criteria in the given campaign. The match is successful if all the attributes of the request are found in a coupon, even if the coupon has more attributes that are not present on the request. Note: The total count is not included in the response.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	map[string]interface{}	body
optional	*SearchCouponsAdvancedWithoutTotalCountOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SearchCouponsAdvancedWithoutTotalCountOpts struct

Name	Type	Description	Notes

pageSize | optional.| The number of items in the response. | [default to 1000] skip | optional.| The number of items to skip when paging through large result sets. | sort | optional.| The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. Note: This parameter works only with numeric fields. | value | optional.| Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | createdBefore | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | createdAfter | optional.| Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any time zone setting. Talon.One will convert to UTC internally. | valid | optional.| Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | usable | optional.| Either "true" or "false". If "true", only coupons where `usageCounter < usageLimit` will be returned, "false" will return only coupons where `usageCounter >= usageLimit`. | referralId | optional.| Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | recipientIntegrationId | optional.| Filter results by match with a profile ID specified in the coupon's RecipientIntegrationId field. | exactMatch | optional.| Filter results to an exact case-insensitive matching against the coupon code. | [default to false] batchId | optional.| Filter results by batches of coupons |

Return type

InlineResponse2009

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

TransferLoyaltyCard

TransferLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId, body)

Transfer card data

Transfer loyalty card data, such as linked customers, loyalty balances and transactions, from a given loyalty card to a new, automatically created loyalty card. Important: - The original card is automatically blocked once the new card is created, and it cannot be activated again. - The default status of the new card is active.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
body	TransferLoyaltyCard	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateAccountCollection

Collection UpdateAccountCollection(ctx, collectionId, body)

Update account-level collection

Edit the description of a given account-level collection and enable or disable the collection in the specified Applications.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
collectionId	int32	The ID of the collection. You can get it with the List collections in account endpoint.
body	UpdateCollection	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateAchievement

Achievement UpdateAchievement(ctx, applicationId, campaignId, achievementId, body)

Update achievement

Update the details of a specific achievement.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
achievementId	int32	The ID of the achievement. You can get this ID with the List achievement endpoint.
body	UpdateAchievement	body

Return type

Achievement

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateAdditionalCost

AccountAdditionalCost UpdateAdditionalCost(ctx, additionalCostId, body)

Update additional cost

Updates an existing additional cost. Once created, the only property of an additional cost that cannot be changed is the name property (or API name in the Campaign Manager). This restriction is in place to prevent accidentally breaking live integrations.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
additionalCostId	int32	The ID of the additional cost. You can find the ID the the Campaign Manager's URL when you display the details of the cost in Account > Tools > Additional costs.
body	NewAdditionalCost	body

Return type

AccountAdditionalCost

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateAttribute

Attribute UpdateAttribute(ctx, attributeId, body)

Update custom attribute

Update an existing custom attribute. Once created, the only property of a custom attribute that can be changed is the description. To change the type or name property of a custom attribute, create a new attribute and update any relevant integrations and rules to use the new attribute.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
attributeId	int32	The ID of the attribute. You can find the ID in the Campaign Manager's URL when you display the details of an attribute in Account > Tools > Attributes.
body	NewAttribute	body

Return type

Attribute

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateCampaign

Campaign UpdateCampaign(ctx, applicationId, campaignId, body)

Update campaign

Update the given campaign. Important: You cannot use this endpoint to update campaigns if campaign staging and revisions is enabled for your Application.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	UpdateCampaign	body

Return type

Campaign

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateCollection

Collection UpdateCollection(ctx, applicationId, campaignId, collectionId, body)

Update campaign-level collection's description

Edit the description of a given campaign-level collection.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
collectionId	int32	The ID of the collection. You can get it with the List collections in Application endpoint.
body	UpdateCampaignCollection	body

Return type

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateCoupon

Coupon UpdateCoupon(ctx, applicationId, campaignId, couponId, body)

Update coupon

Update the specified coupon. <div class="redoc-section"> <p class="title">Important

With this PUT endpoint, if you do not explicitly set a value for the startDate, expiryDate, and recipientIntegrationId properties in your request, it is automatically set to null.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
couponId	string	The internal ID of the coupon code. You can find this value in the `id` property from the List coupons endpoint response.
body	UpdateCoupon	body

Return type

Coupon

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateCouponBatch

UpdateCouponBatch(ctx, applicationId, campaignId, body)

Update coupons

Update all coupons or a specific batch of coupons in the given campaign. You can find the batchId on the Coupons page of your campaign in the Campaign Manager, or you can use List coupons. <div class="redoc-section"> <p class="title">Important

Only send sequential requests to this endpoint.
Requests to this endpoint time out after 30 minutes. If you hit a timeout, contact our support team.
With this PUT endpoint, if you do not explicitly set a value for the startDate and expiryDate properties in your request, it is automatically set to null.

To update a specific coupon, use Update coupon.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
body	UpdateCouponBatch	body

Return type

(empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: Not defined

UpdateLoyaltyCard

LoyaltyCard UpdateLoyaltyCard(ctx, loyaltyProgramId, loyaltyCardId, body)

Update loyalty card status

Update the status of the given loyalty card. A card can be active or inactive.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
loyaltyProgramId	int32	Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.
loyaltyCardId	string	Identifier of the loyalty card. You can get the identifier with the List loyalty cards endpoint.
body	UpdateLoyaltyCard	body

Return type

LoyaltyCard

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateReferral

Referral UpdateReferral(ctx, applicationId, campaignId, referralId, body)

Update referral

Update the specified referral.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
campaignId	int32	The ID of the campaign. It is displayed in your Talon.One deployment URL.
referralId	string	The ID of the referral code.
body	UpdateReferral	body

Return type

Referral

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateRoleV2

RoleV2 UpdateRoleV2(ctx, roleId, body)

Update role

Update a specific role.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
roleId	int32	The ID of role. Note: To find the ID of a role, use the List roles endpoint.
body	RoleV2Base	body

Return type

RoleV2

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateStore

Store UpdateStore(ctx, applicationId, storeId, body)

Update store

Update store details for a specific store ID.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
applicationId	int32	The ID of the Application. It is displayed in your Talon.One deployment URL.
storeId	string	The ID of the store. You can get this ID with the List stores endpoint.
body	NewStore	body

Return type

Store

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

UpdateUser

User UpdateUser(ctx, userId, body)

Update user

Update the details of a specific user.

Required Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
userId	int32	The ID of the user.
body	UpdateUser	body

Return type

User

Authorization