PUT api/me/gifts/{giftId}
This method will update/customize existing gift certificate for user
Requires Authorization!
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| giftId |
Gift certificate record id |
integer |
Required |
Body Parameters
Instance of
UpdateGiftCertificateBindingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| OrderId | integer |
None. |
|
| ClientName | string |
None. |
|
| CustomMessage | string |
None. |
|
| PropertyPin | string |
None. |
|
| MonetaryValue | decimal number |
None. |
|
| IsPurchase | boolean |
None. |
|
| IsForeclosureShortsale | boolean |
None. |
|
| PurchaseDate | string |
None. |
|
| PurchasePrice | decimal number |
None. |
|
| NumYears | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"orderId": 1,
"clientName": "sample string 2",
"customMessage": "sample string 3",
"propertyPin": "sample string 4",
"monetaryValue": 5.1,
"isPurchase": true,
"isForeclosureShortsale": true,
"purchaseDate": "sample string 8",
"purchasePrice": 1.0,
"numYears": 9
}
text/html
Sample:
{"orderId":1,"clientName":"sample string 2","customMessage":"sample string 3","propertyPin":"sample string 4","monetaryValue":5.1,"isPurchase":true,"isForeclosureShortsale":true,"purchaseDate":"sample string 8","purchasePrice":1.0,"numYears":9}
application/xml, text/xml
Sample:
<UpdateGiftCertificateBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Gifting"> <ClientName>sample string 2</ClientName> <CustomMessage>sample string 3</CustomMessage> <IsForeclosureShortsale>true</IsForeclosureShortsale> <IsPurchase>true</IsPurchase> <MonetaryValue>5.1</MonetaryValue> <NumYears>9</NumYears> <OrderId>1</OrderId> <PropertyPin>sample string 4</PropertyPin> <PurchaseDate>sample string 8</PurchaseDate> <PurchasePrice>1</PurchasePrice> </UpdateGiftCertificateBindingModel>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Instance of
GiftCertificateResponseModel| Name | Description | 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-11-01T05:58:49.1565155-05:00",
"clientName": "sample string 4",
"customMessage": "sample string 5",
"propertyPin": "sample string 6",
"isPurchase": true,
"isForeclosureShortsale": true,
"purchaseDate": "2025-11-01T05:58:49.1585435-05:00",
"discountCode": "sample string 9",
"deletedDate": "2025-11-01T05:58:49.1585435-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-11-01T05:58:49.1565155-05:00","clientName":"sample string 4","customMessage":"sample string 5","propertyPin":"sample string 6","isPurchase":true,"isForeclosureShortsale":true,"purchaseDate":"2025-11-01T05:58:49.1585435-05:00","discountCode":"sample string 9","deletedDate":"2025-11-01T05:58:49.1585435-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:
<GiftCertificateResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Gifting"> <AppealNumber>sample string 12</AppealNumber> <CertificateCode>sample string 2</CertificateCode> <ClientName>sample string 4</ClientName> <CreatedDate>2025-11-01T05:58:49.1565155-05:00</CreatedDate> <CustomMessage>sample string 5</CustomMessage> <DeletedDate>2025-11-01T05:58:49.1585435-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-11-01T05:58:49.1585435-05:00</PurchaseDate> <PurchasePrice>1</PurchasePrice> <Url>sample string 15</Url> <UserPropertyAppealId>1</UserPropertyAppealId> </GiftCertificateResponseModel>