How can I use the Response API?
Response API allows you to:
- search for already created responses,
- create new responses to your customers' reviews or AAO questions,
- update your existing responses or prepare draft responses for publishing later,
- delete existing responses or drafts
Create a response
To create a response, you have to use a unique "id" of the entity that you respond to (product review, brand review, ask an owner question).
content_id
Can be obtained using the Search API and then used to create a response as a "content_id".
Example of API request to create a new response for product review
Request:
POST https://fr-api.reevoo.com/api/v1/responses
Request raw body:
{
"content_id": "aaa-111-222-333-444-bbb",
"content_type": "product_review",
"text": "Hi Lucas, thank you for taking time to fill in the review. Your opinion is very important for us and other customers.",
"type": "public",
"status": "published",
"should_notify_customer": true,
"note": "This is a response from David from HR",
"responder_job_title": "HR",
"responder_first_name": "David",
"responder_surname": "Armstrong",
"subject_line": "Thank you for your review, Lucas!",
"reply_to_address": "[email protected]"
}
Response JSON:
201
{
"id": "aaa-111-222-333-444-bbb",
"type": "public",
"text": "Hi Lucas, thank you for taking time to fill in the review. Your opinion is very important for us and other customers.",
"note": "This is a response from David from HR",
"status": "published",
"subject_line": "Thank you for your review, Lucas!",
"reply_to_address": "[email protected].com",
"should_notify_customer": true,
"created_at": "2021-02-23T10:24:22.697+00:00",
"updated_at": null,
"deleted_at": null,
"deleted_by": null,
"trkref": "CLIENT-TRKREF",
"locale": "en-GB",
"content": {
"id": "aaa-111-222-333-444-bbb",
"type": "product_review"
},
"user": {
"id": "xxx-yyy-zzz-123-987"
},
"responder": {
"job_title": "HR",
"first_name": "David",
"surname": "Armstrong",
"custom_title": null,
"display_name": "David Armstrong, HR"
}
}
Update / delete a response
To update or delete a response, you have to pass the id of the response as a path param.