Skip to content

Latest commit

 

History

History
1278 lines (685 loc) · 47.5 KB

IntegrationApi.md

File metadata and controls

1278 lines (685 loc) · 47.5 KB
Raw

\IntegrationApi

All URIs are relative to https://yourbaseurl.talon.one

Method HTTP request Description
CreateAudienceV2 Post /v2/audiences Create audience
CreateCouponReservation Post /v1/coupon_reservations/{couponValue} Create coupon reservation
CreateReferral Post /v1/referrals Create referral code for an advocate
CreateReferralsForMultipleAdvocates Post /v1/referrals_for_multiple_advocates Create referral codes for multiple advocates
DeleteAudienceMembershipsV2 Delete /v2/audiences/{audienceId}/memberships Delete audience memberships
DeleteAudienceV2 Delete /v2/audiences/{audienceId} Delete audience
DeleteCouponReservation Delete /v1/coupon_reservations/{couponValue} Delete coupon reservations
DeleteCustomerData Delete /v1/customer_data/{integrationId} Delete customer's personal data
GetCustomerInventory Get /v1/customer_profiles/{integrationId}/inventory List customer data
GetCustomerSession Get /v2/customer_sessions/{customerSessionId} Get customer session
GetLoyaltyBalances Get /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/balances Get customer's loyalty points
GetLoyaltyCardBalances Get /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/balances Get card's point balances
GetLoyaltyCardPoints Get /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/points List card's unused loyalty points
GetLoyaltyCardTransactions Get /v1/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/transactions List card's transactions
GetLoyaltyProgramProfilePoints Get /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/points List customer's unused loyalty points
GetLoyaltyProgramProfileTransactions Get /v1/loyalty_programs/{loyaltyProgramId}/profile/{integrationId}/transactions List customer's loyalty transactions
GetReservedCustomers Get /v1/coupon_reservations/customerprofiles/{couponValue} List customers that have this coupon reserved
LinkLoyaltyCardToProfile Post /v2/loyalty_programs/{loyaltyProgramId}/cards/{loyaltyCardId}/link_profile Link customer profile to card
ReopenCustomerSession Put /v2/customer_sessions/{customerSessionId}/reopen Reopen customer session
ReturnCartItems Post /v2/customer_sessions/{customerSessionId}/returns Return cart items
SyncCatalog Put /v1/catalogs/{catalogId}/sync Sync cart item catalog
TrackEventV2 Post /v2/events Track event
UpdateAudienceCustomersAttributes Put /v2/audience_customers/{audienceId}/attributes Update profile attributes for all customers in audience
UpdateAudienceV2 Put /v2/audiences/{audienceId} Update audience name
UpdateCustomerProfileAudiences Post /v2/customer_audiences Update multiple customer profiles' audiences
UpdateCustomerProfileV2 Put /v2/customer_profiles/{integrationId} Update customer profile
UpdateCustomerProfilesV2 Put /v2/customer_profiles Update multiple customer profiles
UpdateCustomerSessionV2 Put /v2/customer_sessions/{customerSessionId} Update customer session

CreateAudienceV2

Audience CreateAudienceV2(ctx).Body(body).Execute()

Create audience

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateAudienceV2Request struct via the builder pattern

Name Type Description Notes
body NewAudience body

Return type

Audience

Authorization

api_key_v1

HTTP request headers

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

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

CreateCouponReservation

Coupon CreateCouponReservation(ctx, couponValue).Body(body).Execute()

Create coupon reservation

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
couponValue string The code of the coupon.

Other Parameters

Other parameters are passed through a pointer to a apiCreateCouponReservationRequest struct via the builder pattern

Name Type Description Notes

body | CouponReservations | body |

Return type

Coupon

Authorization

api_key_v1

HTTP request headers

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

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

CreateReferral

Referral CreateReferral(ctx).Body(body).Execute()

Create referral code for an advocate

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateReferralRequest struct via the builder pattern

Name Type Description Notes
body NewReferral body

Return type

Referral

Authorization

api_key_v1

HTTP request headers

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

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

CreateReferralsForMultipleAdvocates

InlineResponse201 CreateReferralsForMultipleAdvocates(ctx).Body(body).Silent(silent).Execute()

Create referral codes for multiple advocates

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateReferralsForMultipleAdvocatesRequest struct via the builder pattern

Name Type Description Notes
body NewReferralsForMultipleAdvocates body
silent string 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

InlineResponse201

Authorization

api_key_v1

HTTP request headers

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

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

DeleteAudienceMembershipsV2

DeleteAudienceMembershipsV2(ctx, audienceId).Execute()

Delete audience memberships

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAudienceMembershipsV2Request struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DeleteAudienceV2

DeleteAudienceV2(ctx, audienceId).Execute()

Delete audience

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAudienceV2Request struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

DeleteCouponReservation

DeleteCouponReservation(ctx, couponValue).Body(body).Execute()

Delete coupon reservations

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
couponValue string The code of the coupon.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteCouponReservationRequest struct via the builder pattern

Name Type Description Notes

body | CouponReservations | body |

Return type

(empty response body)

Authorization

api_key_v1

HTTP request headers

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

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

DeleteCustomerData

DeleteCustomerData(ctx, integrationId).Execute()

Delete customer's personal data

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationId string The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the Update customer session endpoint. - The Management API with the List application's customers endpoint.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteCustomerDataRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetCustomerInventory

CustomerInventory GetCustomerInventory(ctx, integrationId).Profile(profile).Referrals(referrals).Coupons(coupons).Loyalty(loyalty).Giveaways(giveaways).Achievements(achievements).Execute()

List customer data

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationId string The integration ID of the customer profile. You can get the `integrationId` of a profile using: - A customer session integration ID with the Update customer session endpoint. - The Management API with the List application's customers endpoint.

Other Parameters

Other parameters are passed through a pointer to a apiGetCustomerInventoryRequest struct via the builder pattern

Name Type Description Notes

profile | bool | Set to `true` to include customer profile information in the response. | referrals | bool | Set to `true` to include referral information in the response. | coupons | bool | Set to `true` to include coupon information in the response. | loyalty | bool | Set to `true` to include loyalty information in the response. | giveaways | bool | Set to `true` to include giveaways information in the response. | achievements | bool | Set to `true` to include achievement information in the response. |

Return type

CustomerInventory

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetCustomerSession

IntegrationCustomerSessionResponse GetCustomerSession(ctx, customerSessionId).Execute()

Get customer session

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerSessionId string The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's Sessions menu, or via the List Application session endpoint.

Other Parameters

Other parameters are passed through a pointer to a apiGetCustomerSessionRequest struct via the builder pattern

Name Type Description Notes

Return type

IntegrationCustomerSessionResponse

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLoyaltyBalances

LoyaltyBalances GetLoyaltyBalances(ctx, loyaltyProgramId, integrationId).EndDate(endDate).SubledgerId(subledgerId).Execute()

Get customer's loyalty points

Path Parameters

Name Type Description Notes
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.
integrationId string The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

Other Parameters

Other parameters are passed through a pointer to a apiGetLoyaltyBalancesRequest struct via the builder pattern

Name Type Description Notes

endDate | time.Time | 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. | subledgerId | string | The ID of the subledger by which we filter the data. |

Return type

LoyaltyBalances

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLoyaltyCardBalances

LoyaltyCardBalances GetLoyaltyCardBalances(ctx, loyaltyProgramId, loyaltyCardId).EndDate(endDate).SubledgerId(subledgerId).Execute()

Get card's point balances

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

Other Parameters

Other parameters are passed through a pointer to a apiGetLoyaltyCardBalancesRequest struct via the builder pattern

Name Type Description Notes

endDate | time.Time | 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. | subledgerId | []string | Filter results by one or more subledger IDs. Must be exact match. |

Return type

LoyaltyCardBalances

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLoyaltyCardPoints

InlineResponse2003 GetLoyaltyCardPoints(ctx, loyaltyProgramId, loyaltyCardId).Status(status).SubledgerId(subledgerId).PageSize(pageSize).Skip(skip).Execute()

List card's unused loyalty points

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

Other Parameters

Other parameters are passed through a pointer to a apiGetLoyaltyCardPointsRequest struct via the builder pattern

Name Type Description Notes

status | string | Filter points based on their status. | [default to active] subledgerId | []string | Filter results by one or more subledger IDs. Must be exact match. | pageSize | int32 | The number of items in the response. | [default to 50] skip | int32 | The number of items to skip when paging through large result sets. |

Return type

InlineResponse2003

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLoyaltyCardTransactions

InlineResponse2001 GetLoyaltyCardTransactions(ctx, loyaltyProgramId, loyaltyCardId).SubledgerId(subledgerId).LoyaltyTransactionType(loyaltyTransactionType).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute()

List card's transactions

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

Other Parameters

Other parameters are passed through a pointer to a apiGetLoyaltyCardTransactionsRequest struct via the builder pattern

Name Type Description Notes

subledgerId | []string | Filter results by one or more subledger IDs. Must be exact match. | loyaltyTransactionType | string | 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. | startDate | time.Time | 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 | time.Time | 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 | int32 | The number of items in the response. | [default to 1000] skip | int32 | The number of items to skip when paging through large result sets. |

Return type

InlineResponse2001

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLoyaltyProgramProfilePoints

InlineResponse2004 GetLoyaltyProgramProfilePoints(ctx, loyaltyProgramId, integrationId).Status(status).SubledgerId(subledgerId).PageSize(pageSize).Skip(skip).Execute()

List customer's unused loyalty points

Path Parameters

Name Type Description Notes
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.
integrationId string The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

Other Parameters

Other parameters are passed through a pointer to a apiGetLoyaltyProgramProfilePointsRequest struct via the builder pattern

Name Type Description Notes

status | string | Filter points based on their status. | [default to active] subledgerId | string | The ID of the subledger by which we filter the data. | pageSize | int32 | The number of items in the response. | [default to 50] skip | int32 | The number of items to skip when paging through large result sets. |

Return type

InlineResponse2004

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetLoyaltyProgramProfileTransactions

InlineResponse2002 GetLoyaltyProgramProfileTransactions(ctx, loyaltyProgramId, integrationId).SubledgerId(subledgerId).LoyaltyTransactionType(loyaltyTransactionType).StartDate(startDate).EndDate(endDate).PageSize(pageSize).Skip(skip).Execute()

List customer's loyalty transactions

Path Parameters

Name Type Description Notes
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.
integrationId string The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

Other Parameters

Other parameters are passed through a pointer to a apiGetLoyaltyProgramProfileTransactionsRequest struct via the builder pattern

Name Type Description Notes

subledgerId | string | The ID of the subledger by which we filter the data. | loyaltyTransactionType | string | 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. | startDate | time.Time | 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 | time.Time | 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 | int32 | The number of items in the response. | [default to 50] skip | int32 | The number of items to skip when paging through large result sets. |

Return type

InlineResponse2002

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetReservedCustomers

InlineResponse200 GetReservedCustomers(ctx, couponValue).Execute()

List customers that have this coupon reserved

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
couponValue string The code of the coupon.

Other Parameters

Other parameters are passed through a pointer to a apiGetReservedCustomersRequest struct via the builder pattern

Name Type Description Notes

Return type

InlineResponse200

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

LinkLoyaltyCardToProfile

LoyaltyCard LinkLoyaltyCardToProfile(ctx, loyaltyProgramId, loyaltyCardId).Body(body).Execute()

Link customer profile to card

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

Other Parameters

Other parameters are passed through a pointer to a apiLinkLoyaltyCardToProfileRequest struct via the builder pattern

Name Type Description Notes

body | LoyaltyCardRegistration | body |

Return type

LoyaltyCard

Authorization

api_key_v1

HTTP request headers

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

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

ReopenCustomerSession

ReopenSessionResponse ReopenCustomerSession(ctx, customerSessionId).Execute()

Reopen customer session

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerSessionId string The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's Sessions menu, or via the List Application session endpoint.

Other Parameters

Other parameters are passed through a pointer to a apiReopenCustomerSessionRequest struct via the builder pattern

Name Type Description Notes

Return type

ReopenSessionResponse

Authorization

api_key_v1

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

ReturnCartItems

IntegrationStateV2 ReturnCartItems(ctx, customerSessionId).Body(body).Dry(dry).Execute()

Return cart items

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerSessionId string The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's Sessions menu, or via the List Application session endpoint.

Other Parameters

Other parameters are passed through a pointer to a apiReturnCartItemsRequest struct via the builder pattern

Name Type Description Notes

body | ReturnIntegrationRequest | body | dry | bool | Indicates whether to persist the changes. Changes are ignored when `dry=true`. |

Return type

IntegrationStateV2

Authorization

api_key_v1

HTTP request headers

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

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

SyncCatalog

Catalog SyncCatalog(ctx, catalogId).Body(body).Execute()

Sync cart item catalog

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

Other Parameters

Other parameters are passed through a pointer to a apiSyncCatalogRequest struct via the builder pattern

Name Type Description Notes

body | CatalogSyncRequest | body |

Return type

Catalog

Authorization

api_key_v1

HTTP request headers

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

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

TrackEventV2

TrackEventV2Response TrackEventV2(ctx).Body(body).Silent(silent).Dry(dry).Execute()

Track event

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiTrackEventV2Request struct via the builder pattern

Name Type Description Notes
body IntegrationEventV2Request body
silent string 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]
dry bool Indicates whether to persist the changes. Changes are ignored when `dry=true`.

Return type

TrackEventV2Response

Authorization

api_key_v1

HTTP request headers

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

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

UpdateAudienceCustomersAttributes

UpdateAudienceCustomersAttributes(ctx, audienceId).Body(body).Execute()

Update profile attributes for all customers in audience

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiUpdateAudienceCustomersAttributesRequest struct via the builder pattern

Name Type Description Notes

body | map[string]interface{} | body |

Return type

(empty response body)

Authorization

api_key_v1

HTTP request headers

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

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

UpdateAudienceV2

Audience UpdateAudienceV2(ctx, audienceId).Body(body).Execute()

Update audience name

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiUpdateAudienceV2Request struct via the builder pattern

Name Type Description Notes

body | UpdateAudience | body |

Return type

Audience

Authorization

api_key_v1

HTTP request headers

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

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

UpdateCustomerProfileAudiences

UpdateCustomerProfileAudiences(ctx).Body(body).Execute()

Update multiple customer profiles' audiences

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdateCustomerProfileAudiencesRequest struct via the builder pattern

Name Type Description Notes
body CustomerProfileAudienceRequest body

Return type

(empty response body)

Authorization

api_key_v1

HTTP request headers

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

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

UpdateCustomerProfileV2

CustomerProfileIntegrationResponseV2 UpdateCustomerProfileV2(ctx, integrationId).Body(body).RunRuleEngine(runRuleEngine).Dry(dry).Execute()

Update customer profile

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
integrationId string The integration identifier for this customer profile. Must be: - Unique within the deployment. - Stable for the customer. Do not use an ID that the customer can update themselves. For example, you can use a database ID. Once set, you cannot update this identifier.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateCustomerProfileV2Request struct via the builder pattern

Name Type Description Notes

body | CustomerProfileIntegrationRequestV2 | body | runRuleEngine | bool | Indicates whether to run the Rule Engine. If `true`, the response includes: - The effects generated by the triggered campaigns are returned in the `effects` property. - The created coupons and referral objects. If `false`: - The rules are not executed and the `effects` property is always empty. - The response time improves. - You cannot use `responseContent` in the body. | [default to false] dry | bool | (Only works when `runRuleEngine=true`) Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`, you can use the `evaluableCampaignIds` body property to select specific campaigns to run. |

Return type

CustomerProfileIntegrationResponseV2

Authorization

api_key_v1

HTTP request headers

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

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

UpdateCustomerProfilesV2

MultipleCustomerProfileIntegrationResponseV2 UpdateCustomerProfilesV2(ctx).Body(body).Silent(silent).Execute()

Update multiple customer profiles

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiUpdateCustomerProfilesV2Request struct via the builder pattern

Name Type Description Notes
body MultipleCustomerProfileIntegrationRequest body
silent string 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

MultipleCustomerProfileIntegrationResponseV2

Authorization

api_key_v1

HTTP request headers

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

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

UpdateCustomerSessionV2

IntegrationStateV2 UpdateCustomerSessionV2(ctx, customerSessionId).Body(body).Dry(dry).Now(now).Execute()

Update customer session

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
customerSessionId string The `integration ID` of the customer session. You set this ID when you create a customer session. You can see existing customer session integration IDs in the Campaign Manager's Sessions menu, or via the List Application session endpoint.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateCustomerSessionV2Request struct via the builder pattern

Name Type Description Notes

body | IntegrationRequest | body | dry | bool | Indicates whether to persist the changes. Changes are ignored when `dry=true`. When set to `true`: - The endpoint will only consider the payload that you pass when closing the session. When you do not use the `dry` parameter, the endpoint behaves as a typical PUT endpoint. Each update builds upon the previous ones. - You can use the `evaluableCampaignIds` body property to select specific campaigns to run. See the docs. | now | time.Time | A timestamp value of a future date that acts as a current date when included in the query. Use this parameter, for example, to test campaigns that would be evaluated for this customer session in the future (say, scheduled campaigns). Note: - It must be an RFC3339 timestamp string. - It can only be a date in the future. - It can only be used if the `dry` parameter in the query is set to `true`. |

Return type

IntegrationStateV2

Authorization

api_key_v1

HTTP request headers

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

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