POST api/me/gifts

This method will create new gift certificate records for a user

Requires Authorization!

Request Information

URI Parameters

None.

Body Parameters

Instance of

Name	Type	Additional information
OrderId	integer	Required
Quantity	integer	Required
ProductBundleId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "orderId": 1,
  "quantity": 2,
  "productBundleId": 3
}

text/html

Sample:

{"orderId":1,"quantity":2,"productBundleId":3}

application/xml, text/xml

Sample:

<CreateGiftCertificateBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Gifting">
  <OrderId>1</OrderId>
  <ProductBundleId>3</ProductBundleId>
  <Quantity>2</Quantity>
</CreateGiftCertificateBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CreateGiftCertificateBindingModel'.

Response Information

Resource Description

Collection of

Collection of GiftCertificateResponseModel

Name	Type	Additional information
Id	integer	None.
CertificateCode	string	None.
CreatedDate	date	None.
ClientName	string	None.
CustomMessage	string	None.
PropertyPin	string	None.
IsPurchase	boolean	None.
IsForeclosureShortsale	boolean	None.
PurchaseDate	date	None.
DiscountCode	string	None.
DeletedDate	date	None.
UserPropertyAppealId	integer	None.
OrderId	integer	None.
OrderNumber	string	None.
AppealNumber	string	None.
PropertyAddressId	integer	None.
PropertyFullAddress	string	None.
Url	string	None.
PurchasePrice	decimal number	None.
MonetaryValue	decimal number	None.
NumYears	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "certificateCode": "sample string 2",
    "createdDate": "2025-05-20T17:06:23.0927287-05:00",
    "clientName": "sample string 4",
    "customMessage": "sample string 5",
    "propertyPin": "sample string 6",
    "isPurchase": true,
    "isForeclosureShortsale": true,
    "purchaseDate": "2025-05-20T17:06:23.0948039-05:00",
    "discountCode": "sample string 9",
    "deletedDate": "2025-05-20T17:06:23.0948039-05:00",
    "userPropertyAppealId": 1,
    "orderId": 10,
    "orderNumber": "sample string 11",
    "appealNumber": "sample string 12",
    "propertyAddressId": 13,
    "propertyFullAddress": "sample string 14",
    "url": "sample string 15",
    "purchasePrice": 1.0,
    "monetaryValue": 16.0,
    "numYears": 17
  },
  {
    "id": 1,
    "certificateCode": "sample string 2",
    "createdDate": "2025-05-20T17:06:23.0927287-05:00",
    "clientName": "sample string 4",
    "customMessage": "sample string 5",
    "propertyPin": "sample string 6",
    "isPurchase": true,
    "isForeclosureShortsale": true,
    "purchaseDate": "2025-05-20T17:06:23.0948039-05:00",
    "discountCode": "sample string 9",
    "deletedDate": "2025-05-20T17:06:23.0948039-05:00",
    "userPropertyAppealId": 1,
    "orderId": 10,
    "orderNumber": "sample string 11",
    "appealNumber": "sample string 12",
    "propertyAddressId": 13,
    "propertyFullAddress": "sample string 14",
    "url": "sample string 15",
    "purchasePrice": 1.0,
    "monetaryValue": 16.0,
    "numYears": 17
  }
]

text/html

Sample:

[{"id":1,"certificateCode":"sample string 2","createdDate":"2025-05-20T17:06:23.0927287-05:00","clientName":"sample string 4","customMessage":"sample string 5","propertyPin":"sample string 6","isPurchase":true,"isForeclosureShortsale":true,"purchaseDate":"2025-05-20T17:06:23.0948039-05:00","discountCode":"sample string 9","deletedDate":"2025-05-20T17:06:23.0948039-05:00","userPropertyAppealId":1,"orderId":10,"orderNumber":"sample string 11","appealNumber":"sample string 12","propertyAddressId":13,"propertyFullAddress":"sample string 14","url":"sample string 15","purchasePrice":1.0,"monetaryValue":16.0,"numYears":17},{"id":1,"certificateCode":"sample string 2","createdDate":"2025-05-20T17:06:23.0927287-05:00","clientName":"sample string 4","customMessage":"sample string 5","propertyPin":"sample string 6","isPurchase":true,"isForeclosureShortsale":true,"purchaseDate":"2025-05-20T17:06:23.0948039-05:00","discountCode":"sample string 9","deletedDate":"2025-05-20T17:06:23.0948039-05:00","userPropertyAppealId":1,"orderId":10,"orderNumber":"sample string 11","appealNumber":"sample string 12","propertyAddressId":13,"propertyFullAddress":"sample string 14","url":"sample string 15","purchasePrice":1.0,"monetaryValue":16.0,"numYears":17}]

application/xml, text/xml

Sample:

<ArrayOfGiftCertificateResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Gifting">
  <GiftCertificateResponseModel>
    <AppealNumber>sample string 12</AppealNumber>
    <CertificateCode>sample string 2</CertificateCode>
    <ClientName>sample string 4</ClientName>
    <CreatedDate>2025-05-20T17:06:23.0927287-05:00</CreatedDate>
    <CustomMessage>sample string 5</CustomMessage>
    <DeletedDate>2025-05-20T17:06:23.0948039-05:00</DeletedDate>
    <DiscountCode>sample string 9</DiscountCode>
    <Id>1</Id>
    <IsForeclosureShortsale>true</IsForeclosureShortsale>
    <IsPurchase>true</IsPurchase>
    <MonetaryValue>16</MonetaryValue>
    <NumYears>17</NumYears>
    <OrderId>10</OrderId>
    <OrderNumber>sample string 11</OrderNumber>
    <PropertyAddressId>13</PropertyAddressId>
    <PropertyFullAddress>sample string 14</PropertyFullAddress>
    <PropertyPin>sample string 6</PropertyPin>
    <PurchaseDate>2025-05-20T17:06:23.0948039-05:00</PurchaseDate>
    <PurchasePrice>1</PurchasePrice>
    <Url>sample string 15</Url>
    <UserPropertyAppealId>1</UserPropertyAppealId>
  </GiftCertificateResponseModel>
  <GiftCertificateResponseModel>
    <AppealNumber>sample string 12</AppealNumber>
    <CertificateCode>sample string 2</CertificateCode>
    <ClientName>sample string 4</ClientName>
    <CreatedDate>2025-05-20T17:06:23.0927287-05:00</CreatedDate>
    <CustomMessage>sample string 5</CustomMessage>
    <DeletedDate>2025-05-20T17:06:23.0948039-05:00</DeletedDate>
    <DiscountCode>sample string 9</DiscountCode>
    <Id>1</Id>
    <IsForeclosureShortsale>true</IsForeclosureShortsale>
    <IsPurchase>true</IsPurchase>
    <MonetaryValue>16</MonetaryValue>
    <NumYears>17</NumYears>
    <OrderId>10</OrderId>
    <OrderNumber>sample string 11</OrderNumber>
    <PropertyAddressId>13</PropertyAddressId>
    <PropertyFullAddress>sample string 14</PropertyFullAddress>
    <PropertyPin>sample string 6</PropertyPin>
    <PurchaseDate>2025-05-20T17:06:23.0948039-05:00</PurchaseDate>
    <PurchasePrice>1</PurchasePrice>
    <Url>sample string 15</Url>
    <UserPropertyAppealId>1</UserPropertyAppealId>
  </GiftCertificateResponseModel>
</ArrayOfGiftCertificateResponseModel>