Skip to main content

PromotionsService

A list of all methods in the PromotionsService service. Click on the method name to view detailed information about that method.

MethodsDescription
MultichannelPromotionsGetByIdAsyncGets the multichannel promotion with the identifier which is set by Voyado
MultichannelPromotionsUpdateAsyncUpdates an existing multichannel promotion. Only multichannel promotion in status 'Draft' can be updated.
MultichannelPromotionsDeleteByIdAsyncOnly unassigned multichannel promotions can be deleted
MultichannelPromotionsGetValidityByIdAsyncGets the multichannel promotion with the identifier which is an internal reference for Voyado
MultichannelPromotionsUpdateValidityAsyncUpdates duration of an existing multichannel promotion. Only multichannel promotion in status 'Draft' can be updated.
MultichannelPromotionsGetByExternalIdAsyncGets the multichannel promotion with the identifier which is an external reference for Voyado
MultichannelPromotionsCreateAsyncOnly creates multichannel promotion in status 'Draft'.
MultichannelPromotionsDeleteByExternalIdAsyncOnly unassigned multichannel promotions can be deleted
MultichannelPromotionsGetByValidityExternalIdAsyncGets the multichannel promotion validity with the identifier which is an external reference for Voyado
OfferPromotionsRedeemByPromotionIdAsyncRedeem a promotion (multichannel offer or mobile swipe) for a Contact using the internal promotion Id Redemption channel can be POS, ECOM or OTHER.
OfferPromotionsReactivatePromotionCodeAsyncReactivate a redeemed reward voucher

MultichannelPromotionsGetByIdAsync

Gets the multichannel promotion with the identifier which is set by Voyado

  • HTTP Method: GET
  • Endpoint: /api/v2/promotions/multichannels/{id}

Parameters

NameTypeRequiredDescription
idstringPromotion identifier from Voyado

Return Type

MultichannelPromotionModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.MultichannelPromotionsGetByIdAsync("id");

Console.WriteLine(response);

MultichannelPromotionsUpdateAsync

Updates an existing multichannel promotion. Only multichannel promotion in status 'Draft' can be updated.

  • HTTP Method: PUT
  • Endpoint: /api/v2/promotions/multichannels/{id}

Parameters

NameTypeRequiredDescription
inputMultichannelPromotionModelThe request body.
idstringVoyado multichannel promotion identifier

Return Type

MultichannelPromotionModel

Example Usage Code Snippet

using VoyadoEngage;
using VoyadoEngage.Models;

var client = new VoyadoEngageClient();

var input = new MultichannelPromotionModel("00000000-0000-0000-0000-000000000000", "name");

var response = await client.Promotions.MultichannelPromotionsUpdateAsync(input, "id");

Console.WriteLine(response);

MultichannelPromotionsDeleteByIdAsync

Only unassigned multichannel promotions can be deleted

  • HTTP Method: DELETE
  • Endpoint: /api/v2/promotions/multichannels/{id}

Parameters

NameTypeRequiredDescription
idstringVoyado identifier to a multichannel promotion

Return Type

StatusCodeResult

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.MultichannelPromotionsDeleteByIdAsync("id");

Console.WriteLine(response);

MultichannelPromotionsGetValidityByIdAsync

Gets the multichannel promotion with the identifier which is an internal reference for Voyado

  • HTTP Method: GET
  • Endpoint: /api/v2/promotions/multichannels/{id}/validity

Parameters

NameTypeRequiredDescription
idstringIdentifier inside of Voyado

Return Type

PromotionValidityModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.MultichannelPromotionsGetValidityByIdAsync("id");

Console.WriteLine(response);

MultichannelPromotionsUpdateValidityAsync

Updates duration of an existing multichannel promotion. Only multichannel promotion in status 'Draft' can be updated.

  • HTTP Method: PUT
  • Endpoint: /api/v2/promotions/multichannels/{id}/validity

Parameters

NameTypeRequiredDescription
inputPromotionValidityModelThe request body.
idstringVoyado multichannel promotion identifier

Return Type

MultichannelPromotionModel

Example Usage Code Snippet

using VoyadoEngage;
using VoyadoEngage.Models;

var client = new VoyadoEngageClient();

var input = new PromotionValidityModel("startDate");

var response = await client.Promotions.MultichannelPromotionsUpdateValidityAsync(input, "id");

Console.WriteLine(response);

MultichannelPromotionsGetByExternalIdAsync

Gets the multichannel promotion with the identifier which is an external reference for Voyado

  • HTTP Method: GET
  • Endpoint: /api/v2/promotions/multichannels

Parameters

NameTypeRequiredDescription
externalIdstringExternal identifier outside of Voyado

Return Type

MultichannelPromotionModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.MultichannelPromotionsGetByExternalIdAsync("externalId");

Console.WriteLine(response);

MultichannelPromotionsCreateAsync

Only creates multichannel promotion in status 'Draft'.

  • HTTP Method: POST
  • Endpoint: /api/v2/promotions/multichannels

Parameters

NameTypeRequiredDescription
inputMultichannelBasePromotionModelThe request body.

Return Type

MultichannelPromotionModel

Example Usage Code Snippet

using VoyadoEngage;
using VoyadoEngage.Models;

var client = new VoyadoEngageClient();

var input = new MultichannelBasePromotionModel("name");

var response = await client.Promotions.MultichannelPromotionsCreateAsync(input);

Console.WriteLine(response);

MultichannelPromotionsDeleteByExternalIdAsync

Only unassigned multichannel promotions can be deleted

  • HTTP Method: DELETE
  • Endpoint: /api/v2/promotions/multichannels

Parameters

NameTypeRequiredDescription
externalIdstringExternal identifier to a multichannel promotion

Return Type

StatusCodeResult

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.MultichannelPromotionsDeleteByExternalIdAsync("externalId");

Console.WriteLine(response);

MultichannelPromotionsGetByValidityExternalIdAsync

Gets the multichannel promotion validity with the identifier which is an external reference for Voyado

  • HTTP Method: GET
  • Endpoint: /api/v2/promotions/multichannels/validity

Parameters

NameTypeRequiredDescription
externalIdstringExternal identifier outside of Voyado

Return Type

PromotionValidityModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.MultichannelPromotionsGetByValidityExternalIdAsync("externalId");

Console.WriteLine(response);

OfferPromotionsRedeemByPromotionIdAsync

Redeem a promotion (multichannel offer or mobile swipe) for a Contact using the internal promotion Id Redemption channel can be POS, ECOM or OTHER.

  • HTTP Method: POST
  • Endpoint: /api/v2/promotions/codes/{promotionId}/redeem

Parameters

NameTypeRequiredDescription
inputRedeemBodyModelThe request body.
promotionIdstringThe id of the promotion

Return Type

object

Example Usage Code Snippet

using VoyadoEngage;
using VoyadoEngage.Models;

var client = new VoyadoEngageClient();

var input = new RedeemBodyModel();

var response = await client.Promotions.OfferPromotionsRedeemByPromotionIdAsync(input, "promotionId");

Console.WriteLine(response);

OfferPromotionsReactivatePromotionCodeAsync

Reactivate a redeemed reward voucher

  • HTTP Method: POST
  • Endpoint: /api/v2/promotions/reward-vouchers/{id}/reactivate

Parameters

NameTypeRequiredDescription
idstringThe id of the reward voucher

Return Type

string

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Promotions.OfferPromotionsReactivatePromotionCodeAsync("id");

Console.WriteLine(response);

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →