POST api/Offers/ThirdParty

Request Information

URI Parameters

None.

Body Parameters

PostThirdPartyOffer
NameDescriptionTypeAdditional information
CompanyId

globally unique identifier

None.

CampaignName

string

None.

CampaignGroupName

string

None.

DisplayLabelNames

Collection of string

None.

QrCodeCountryCode

string

None.

OfferType

OfferType

None.

Name

string

String length: inclusive between 0 and 100

Remarks

string

String length: inclusive between 0 and 400

Title

string

String length: inclusive between 0 and 100

Description

string

String length: inclusive between 0 and 800

TermsAndConditions

string

String length: inclusive between 0 and 5000

RequiresAutograph

boolean

None.

CustomFields

Collection of IOfferFieldDefinition

None.

RequiredFields

OrderDetailFieldType

None.

Price

decimal number

Range: inclusive between 0.00 and 999999999999999999.99

CurrencyCode

string

Required

AskLoyaltyOptIn

boolean

None.

LoyaltyCode

string

None.

LoyaltyQuestion

string

None.

DataPartner

string

None.

Image

Collection of byte

Max length: 512000

Start

date

None.

End

date

None.

PublisherId

globally unique identifier

None.

PaymentHandler

PaymentHandler

None.

DeliveryCountryCode

string

Required

HasVaultOption

boolean

Required

RetentionDays

integer

None.

AllowWebSubmissions

boolean

None.

OfferCodeType

OfferCodeType

None.

MaxOfferCodes

integer

None.

ManualOfferCodes

Collection of string

None.

EmailTemplateSelection

OfferEmailTemplateSelection

None.

ConfirmationAttachment

Collection of byte

Max length: 2048000

ConfirmationAttachmentName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CompanyId": "d2ea7f5b-e9fc-4d0f-9c88-70a336767d60",
  "CampaignName": "sample string 2",
  "CampaignGroupName": "sample string 3",
  "DisplayLabelNames": null,
  "QrCodeCountryCode": "sample string 4",
  "OfferType": 1,
  "Name": "sample string 5",
  "Remarks": "sample string 6",
  "Title": "sample string 7",
  "Description": "sample string 8",
  "TermsAndConditions": "sample string 9",
  "RequiresAutograph": true,
  "CustomFields": null,
  "RequiredFields": 0,
  "Price": 1.0,
  "CurrencyCode": "sample string 11",
  "AskLoyaltyOptIn": true,
  "LoyaltyCode": "sample string 13",
  "LoyaltyQuestion": "sample string 14",
  "DataPartner": "sample string 15",
  "Image": "QEA=",
  "Start": "2022-04-28T23:53:51.9514504+00:00",
  "End": "2022-04-28T23:53:51.9514504+00:00",
  "PublisherId": "a489eb70-957a-414d-91f3-5a74edce3bf5",
  "PaymentHandler": 0,
  "DeliveryCountryCode": "sample string 18",
  "HasVaultOption": true,
  "RetentionDays": 1,
  "AllowWebSubmissions": true,
  "OfferCodeType": 0,
  "MaxOfferCodes": 21,
  "ManualOfferCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailTemplateSelection": {
    "Localization": 11,
    "TemplateId": "6b0e7f62-be82-4b8f-9417-7809f740dba4"
  },
  "ConfirmationAttachment": "QEA=",
  "ConfirmationAttachmentName": "sample string 22"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.