PUT api/Offers/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

PostOffer
NameDescriptionTypeAdditional information
SourceOfferId

globally unique identifier

None.

CampaignId

globally unique identifier

None.

OfferType

OfferType

None.

CampaignGroupId

globally unique identifier

None.

ScanCode

string

String length: inclusive between 0 and 200

NumberOfSerialNumbers

integer

Range: inclusive between 1 and 2147483647

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 OfferFieldDefinition

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.

OfferCodeType

OfferCodeType

None.

MaxOfferCodes

integer

Range: inclusive between 0 and 9999999

ManualOfferCodes

Collection of string

None.

EmailTemplateSelection

OfferEmailTemplateSelection

None.

ConfirmationAttachment

Collection of byte

Max length: 2048000

ConfirmationAttachmentName

string

None.

RemoveExistingConfirmationAttachment

boolean

None.

AllowWebSubmissions

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "SourceOfferId": "b3cdb267-929f-4e94-9f5b-d4b3097c18be",
  "CampaignId": "ffbbf57c-5004-49c9-8081-7fcea29b0023",
  "OfferType": 1,
  "CampaignGroupId": "6b33baf5-a27d-44e0-83c2-87c11d8562e5",
  "ScanCode": "sample string 3",
  "NumberOfSerialNumbers": 4,
  "Name": "sample string 5",
  "Remarks": "sample string 6",
  "Title": "sample string 7",
  "Description": "sample string 8",
  "TermsAndConditions": "sample string 9",
  "RequiresAutograph": true,
  "CustomFields": [
    {
      "Id": "c5644c6b-8483-46d6-98cf-4f7696e083e8",
      "Order": 2,
      "Title": "sample string 3",
      "Type": 0,
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Id": "c5644c6b-8483-46d6-98cf-4f7696e083e8",
      "Order": 2,
      "Title": "sample string 3",
      "Type": 0,
      "Values": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "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-05-21T09:42:50.3396031+00:00",
  "End": "2022-05-21T09:42:50.3396031+00:00",
  "PublisherId": "d40b7e55-6d8a-43ba-bcc9-f65942582144",
  "PaymentHandler": 0,
  "DeliveryCountryCode": "sample string 18",
  "HasVaultOption": true,
  "RetentionDays": 1,
  "OfferCodeType": 0,
  "MaxOfferCodes": 1,
  "ManualOfferCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailTemplateSelection": {
    "Localization": 11,
    "TemplateId": "52bb05d0-29a5-47d0-9c3b-9876e112b2e1"
  },
  "ConfirmationAttachment": "QEA=",
  "ConfirmationAttachmentName": "sample string 20",
  "RemoveExistingConfirmationAttachment": true,
  "AllowWebSubmissions": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IOffer
NameDescriptionTypeAdditional information
Enabled

boolean

None.

Blocked

boolean

None.

CampaignId

globally unique identifier

None.

CampaignGroupId

globally unique identifier

None.

CreatorUserId

string

None.

BarcodeId

globally unique identifier

None.

Name

string

None.

Version

integer

None.

IsLatestVersion

boolean

None.

Remarks

string

None.

AllowWebSubmissions

boolean

None.

Created

date

None.

LastModified

date

None.

DeliveryCountryCode

string

None.

PublisherId

globally unique identifier

None.

HasVaultOption

boolean

None.

RetentionDays

integer

None.

OfferCodeType

OfferCodeType

None.

MaxOfferCodes

integer

None.

HumanReadableOfferId

string

None.

Response Formats

application/json, text/json

Sample:

Sample not available.