List

List Request

List the data for a single email request or all email requests for a particular location.

  • location_id - string
    [Required] Hotel location ID which has been mapped through your TripConnect mapping or Review Express connectivity mapping.
  • request_id - integer
    Tripadvisor ID for the email request. May be used in subsequent update or cancel calls.
  • partner_request_id - string(64)
    [Optional] Partner-defined ID for the email request, e.g. a booking ID. May be used instead of the request_id field (the Tripadvisor email request ID as returned by this call) to cancel or update the request in future calls.

Example Request

GET
https://api.tripadvisor.com/api/partner/1.0/email_requests/{request_id}

or

https://api.tripadvisor.com/api/partner/1.0/email_requests?partner_request_id={partner_request_id}

or list by location

https://api.tripadvisor.com/api/partner/1.0/email_requests?location_id={location_id}

List Response

Return value from listing email requests.

  • request_id - integer
    Tripadvisor ID for the email request. May be used in subsequent update or cancel calls.
  • partner_request_id - string(64)
    [Optional] Partner-defined ID for the email request, e.g. a booking ID. May be used instead of the request_id field (the Tripadvisor email request ID as returned by this call) to cancel or update the request in future calls.
  • recipient - string(128)
    Recipient for the email request. Must contain an @ symbol and at least one period. Must not end in a period. Only a short form email address like mme.toutlemonde@example.fr will be accepted — "Madame Toutlemonde" <mme.toutlemonde@example.fr> would not be accepted.
  • checkout - string(10)
    [Required] Check-out date for related booking or reservation. The Review Express email will be sent to the guest email address 2 days after this date. Must be in ISO-8601 YYYY-MM-DD format. The Review Express API will accept a request at any time prior to the day after the check-out date; a request with a check-out date earlier than yesterday will be rejected, as the e-mail queue for that day will already have been processed.
  • status - string(10)
    Status of the email request — will always be "queued", for a new request, may be "sent" or "canceled" when listing requests.

Example Response

BODY
{
  "data": [
    {
        "request_id": 4,
        "partner_request_id": null,
        "location_id": "h89575",
        "recipient": "gromit@example.co.uk",
        "checkin": null,
        "checkout": "2013-12-13",
        "language": "en_UK",
        "country": "GB",
        "status": "sent"
    },
    {
      "request_id": 7,
      "location_id": "h89575",
      "partner_request_id": null,
      "recipient": "john@example.com",
      "checkin": null,
      "checkout": "2013-12-31",
      "language": "en_US",
      "country": "US",
      "status": "queued"
    },
    {
      "request_id": 8,
      "location_id": "h89575",
      "partner_request_id": "745C6BFF-F0C7-401F-A691-4407F78DC96C",
      "recipient": "mme.toutlemonde@example.fr",
      "checkin": "2013-11-07",
      "checkout": "2013-11-12",
      "language": "fr",
      "country": "FR",
      "status": "queued"
    }
  ],
  "paging": {
    "previous": null,
    "skipped": "0",
    "results": "3",
    "next": null,
    "total_results": "3"
  }
}