POST api/Offer

Request Information

URI Parameters

None.

Body Parameters

Offer
NameDescriptionTypeAdditional information
ID

integer

None.

OfferName

string

None.

CustomerCode

string

None.

AdAccountID

integer

None.

NodeCode

integer

None.

FromFacebook

boolean

None.

SocialOffers

Collection of SocialOffer

None.

CreatedBy

integer

None.

CreatedByName

string

String length: inclusive between 0 and 100

CreateDate

date

None.

LastModifiedBy

integer

None.

LastModifiedByName

string

String length: inclusive between 0 and 100

LastModifiedOn

date

None.

IsDeleted

integer

None.

DeletedBy

integer

None.

DeletedByName

string

String length: inclusive between 0 and 100

DeleteDate

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "OfferName": "sample string 2",
  "CustomerCode": "sample string 3",
  "AdAccountID": 1,
  "NodeCode": 1,
  "FromFacebook": true,
  "SocialOffers": [
    {
      "ID": 1,
      "OfferID": 2,
      "PageID": "sample string 3",
      "Page": {
        "PageID": "sample string 1",
        "PageName": "sample string 2",
        "city": "sample string 3",
        "city_id": "sample string 4",
        "city_key": "sample string 5",
        "country": "sample string 6",
        "country_code": "sample string 7",
        "latitude": 1.1,
        "longitude": 1.1,
        "competitor_latitude": 1.1,
        "competitor_longitude": 1.1,
        "region": "sample string 8",
        "region_id": "sample string 9",
        "region_key": "sample string 10",
        "state": "sample string 11",
        "street": "sample string 12",
        "zip": "sample string 13",
        "zip_key": "sample string 14",
        "leadgen_tos_accepted": true,
        "instagram_account": "sample string 16",
        "instagram_business_account": "sample string 17",
        "instagram_username": "sample string 18",
        "page_picture": "sample string 19",
        "website": "sample string 20",
        "Phone": "sample string 21",
        "Email": "sample string 22",
        "SiteID": 1,
        "username": "sample string 23",
        "AddedDate": "16/10/2025 02:38",
        "BrandName": "sample string 24",
        "MediaID": 25,
        "URL": "sample string 26",
        "OtherDetails": "sample string 27",
        "Category": "sample string 28",
        "IsActive": true,
        "ParentPageID": "sample string 30",
        "Deleted": true,
        "Webhook": true,
        "WebhookAccessToken": "sample string 32",
        "WebhookURD": "16/10/2025 02:38",
        "AddedBy": 1,
        "DeletedBy": 1,
        "PageFacebookUsers": [
          {
            "FacebookUserID": "sample string 1",
            "PageID": "sample string 2",
            "TwitterUserAccessToken": "sample string 3",
            "AddedByFacebookUserID": "sample string 4",
            "Validity": 1,
            "page_permissions": "sample string 6"
          },
          {
            "FacebookUserID": "sample string 1",
            "PageID": "sample string 2",
            "TwitterUserAccessToken": "sample string 3",
            "AddedByFacebookUserID": "sample string 4",
            "Validity": 1,
            "page_permissions": "sample string 6"
          }
        ],
        "PageLocations": [
          {
            "ID": 1,
            "name": "sample string 2",
            "city": "sample string 3",
            "city_id": "sample string 4",
            "city_key": "sample string 5",
            "country": "sample string 6",
            "country_code": "sample string 7",
            "latitude": 1.1,
            "longitude": 1.1,
            "competitor_latitude": 1.1,
            "competitor_longitude": 1.1,
            "region": "sample string 8",
            "region_id": "sample string 9",
            "region_key": "sample string 10",
            "state": "sample string 11",
            "street": "sample string 12",
            "zip": "sample string 13",
            "zip_key": "sample string 14",
            "from_fb": true,
            "PageID": "sample string 16",
            "CreatedBy": 17,
            "CreatedByName": "sample string 18",
            "CreateDate": "16/10/2025 02:38",
            "LastModifiedBy": 19,
            "LastModifiedByName": "sample string 20",
            "LastModifiedOn": "16/10/2025 02:38",
            "IsDeleted": 21,
            "DeletedBy": 22,
            "DeletedByName": "sample string 23",
            "DeleteDate": "16/10/2025 02:38",
            "RealPageID": "sample string 24"
          },
          {
            "ID": 1,
            "name": "sample string 2",
            "city": "sample string 3",
            "city_id": "sample string 4",
            "city_key": "sample string 5",
            "country": "sample string 6",
            "country_code": "sample string 7",
            "latitude": 1.1,
            "longitude": 1.1,
            "competitor_latitude": 1.1,
            "competitor_longitude": 1.1,
            "region": "sample string 8",
            "region_id": "sample string 9",
            "region_key": "sample string 10",
            "state": "sample string 11",
            "street": "sample string 12",
            "zip": "sample string 13",
            "zip_key": "sample string 14",
            "from_fb": true,
            "PageID": "sample string 16",
            "CreatedBy": 17,
            "CreatedByName": "sample string 18",
            "CreateDate": "16/10/2025 02:38",
            "LastModifiedBy": 19,
            "LastModifiedByName": "sample string 20",
            "LastModifiedOn": "16/10/2025 02:38",
            "IsDeleted": 21,
            "DeletedBy": 22,
            "DeletedByName": "sample string 23",
            "DeleteDate": "16/10/2025 02:38",
            "RealPageID": "sample string 24"
          }
        ],
        "PageCustomerCodes": [
          {
            "CustomerCode": "sample string 1",
            "PageID": "sample string 2",
            "Visible": true,
            "BrandID": 1,
            "SiteID": 1,
            "CompetitorID": 1,
            "PushNotifications": "sample string 4"
          },
          {
            "CustomerCode": "sample string 1",
            "PageID": "sample string 2",
            "Visible": true,
            "BrandID": 1,
            "SiteID": 1,
            "CompetitorID": 1,
            "PushNotifications": "sample string 4"
          }
        ]
      },
      "SocialOfferID": "sample string 4",
      "redemption_link": "sample string 5",
      "FromFacebook": true
    },
    {
      "ID": 1,
      "OfferID": 2,
      "PageID": "sample string 3",
      "Page": {
        "PageID": "sample string 1",
        "PageName": "sample string 2",
        "city": "sample string 3",
        "city_id": "sample string 4",
        "city_key": "sample string 5",
        "country": "sample string 6",
        "country_code": "sample string 7",
        "latitude": 1.1,
        "longitude": 1.1,
        "competitor_latitude": 1.1,
        "competitor_longitude": 1.1,
        "region": "sample string 8",
        "region_id": "sample string 9",
        "region_key": "sample string 10",
        "state": "sample string 11",
        "street": "sample string 12",
        "zip": "sample string 13",
        "zip_key": "sample string 14",
        "leadgen_tos_accepted": true,
        "instagram_account": "sample string 16",
        "instagram_business_account": "sample string 17",
        "instagram_username": "sample string 18",
        "page_picture": "sample string 19",
        "website": "sample string 20",
        "Phone": "sample string 21",
        "Email": "sample string 22",
        "SiteID": 1,
        "username": "sample string 23",
        "AddedDate": "16/10/2025 02:38",
        "BrandName": "sample string 24",
        "MediaID": 25,
        "URL": "sample string 26",
        "OtherDetails": "sample string 27",
        "Category": "sample string 28",
        "IsActive": true,
        "ParentPageID": "sample string 30",
        "Deleted": true,
        "Webhook": true,
        "WebhookAccessToken": "sample string 32",
        "WebhookURD": "16/10/2025 02:38",
        "AddedBy": 1,
        "DeletedBy": 1,
        "PageFacebookUsers": [
          {
            "FacebookUserID": "sample string 1",
            "PageID": "sample string 2",
            "TwitterUserAccessToken": "sample string 3",
            "AddedByFacebookUserID": "sample string 4",
            "Validity": 1,
            "page_permissions": "sample string 6"
          },
          {
            "FacebookUserID": "sample string 1",
            "PageID": "sample string 2",
            "TwitterUserAccessToken": "sample string 3",
            "AddedByFacebookUserID": "sample string 4",
            "Validity": 1,
            "page_permissions": "sample string 6"
          }
        ],
        "PageLocations": [
          {
            "ID": 1,
            "name": "sample string 2",
            "city": "sample string 3",
            "city_id": "sample string 4",
            "city_key": "sample string 5",
            "country": "sample string 6",
            "country_code": "sample string 7",
            "latitude": 1.1,
            "longitude": 1.1,
            "competitor_latitude": 1.1,
            "competitor_longitude": 1.1,
            "region": "sample string 8",
            "region_id": "sample string 9",
            "region_key": "sample string 10",
            "state": "sample string 11",
            "street": "sample string 12",
            "zip": "sample string 13",
            "zip_key": "sample string 14",
            "from_fb": true,
            "PageID": "sample string 16",
            "CreatedBy": 17,
            "CreatedByName": "sample string 18",
            "CreateDate": "16/10/2025 02:38",
            "LastModifiedBy": 19,
            "LastModifiedByName": "sample string 20",
            "LastModifiedOn": "16/10/2025 02:38",
            "IsDeleted": 21,
            "DeletedBy": 22,
            "DeletedByName": "sample string 23",
            "DeleteDate": "16/10/2025 02:38",
            "RealPageID": "sample string 24"
          },
          {
            "ID": 1,
            "name": "sample string 2",
            "city": "sample string 3",
            "city_id": "sample string 4",
            "city_key": "sample string 5",
            "country": "sample string 6",
            "country_code": "sample string 7",
            "latitude": 1.1,
            "longitude": 1.1,
            "competitor_latitude": 1.1,
            "competitor_longitude": 1.1,
            "region": "sample string 8",
            "region_id": "sample string 9",
            "region_key": "sample string 10",
            "state": "sample string 11",
            "street": "sample string 12",
            "zip": "sample string 13",
            "zip_key": "sample string 14",
            "from_fb": true,
            "PageID": "sample string 16",
            "CreatedBy": 17,
            "CreatedByName": "sample string 18",
            "CreateDate": "16/10/2025 02:38",
            "LastModifiedBy": 19,
            "LastModifiedByName": "sample string 20",
            "LastModifiedOn": "16/10/2025 02:38",
            "IsDeleted": 21,
            "DeletedBy": 22,
            "DeletedByName": "sample string 23",
            "DeleteDate": "16/10/2025 02:38",
            "RealPageID": "sample string 24"
          }
        ],
        "PageCustomerCodes": [
          {
            "CustomerCode": "sample string 1",
            "PageID": "sample string 2",
            "Visible": true,
            "BrandID": 1,
            "SiteID": 1,
            "CompetitorID": 1,
            "PushNotifications": "sample string 4"
          },
          {
            "CustomerCode": "sample string 1",
            "PageID": "sample string 2",
            "Visible": true,
            "BrandID": 1,
            "SiteID": 1,
            "CompetitorID": 1,
            "PushNotifications": "sample string 4"
          }
        ]
      },
      "SocialOfferID": "sample string 4",
      "redemption_link": "sample string 5",
      "FromFacebook": true
    }
  ],
  "CreatedBy": 5,
  "CreatedByName": "sample string 6",
  "CreateDate": "16/10/2025 02:38",
  "LastModifiedBy": 7,
  "LastModifiedByName": "sample string 8",
  "LastModifiedOn": "16/10/2025 02:38",
  "IsDeleted": 9,
  "DeletedBy": 10,
  "DeletedByName": "sample string 11",
  "DeleteDate": "16/10/2025 02:38"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.