VRvrio
Order Offers

Edit order offer gift details

Edit order offer gift details.

patch/order_offers/{order_offer_id}/gift

Request

  • Base URL
    https://api.vrio.app
  • URL
    https://api.vrio.app/order_offers/{order_offer_id}/gift
  • Auth
    API key in header X-Api-Key

Request body

gift_messagestring

Message to use for gift communication. Required if is_gift is true.

gift_namestring

Name for the person receiving the gift. Required if is_gift is true.

gift_datestring date-time

Date to send gift communication. Required if is_gift is true.

gift_emailstring

Email for the person receiving the gift. Required if is_gift is true.

gift_phonestring

Phone for the person receiving the gift. Required if is_gift is true.

order_offer_notesstring

Apply note to the history of this order offer.

Example request

{
  "gift_date": "2023-04-01 00:00:00"
}

Response

OK

order_offer_idinteger
gift_card_codestring nullable
gift_namestring nullable
gift_messagestring nullable
gift_emailstring nullable
gift_phonestring nullable
gift_datestring date-time nullable
gift_date_sentstring date-time nullable
gift_statusstring

Example response

{
  "gift_date": "2023-04-01 00:00:00",
  "gift_date_sent": "2023-04-01 00:00:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.