AccessAPI key with testimonials:writeAvailable toDirect and platform keys
Parameters
- Path
id
- stringRequired
The feedback ID.
- Header
Idempotency-Key
- stringOptional
Strongly recommended. Replays the same response for 24 hours without sending another email; changed input with the same key returns 409.
- Body
testimonialComment
- stringRequired
Proposed testimonial wording, 1–2000 characters after trimming. The original response must have a comment.
- Body
testimonialName
- string or nullOptional
Proposed display name, up to 255 characters. Omit, use null, or leave blank for Anonymous. The customer can change it.
- Body
externalAccountId
- stringOptional
Required for a platform key; omit for a direct key.
Example request
curl "$API_BASE_URL/v1/feedback/fbk_H7ks82/testimonial-request" \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: testimonial-booking-83921-v1" \
-d '{"testimonialComment":"A wonderful experience.","testimonialName":"Jane B."}'
200 OK (feedback record; excerpt)
{
"id": "fbk_H7ks82",
"testimonialStatus": "pending",
"testimonialComment": "A wonderful experience.",
"testimonialName": "Jane B.",
"testimonialRequestedAt": "2026-10-22T00:00:00.000Z",
"testimonialExpiresAt": "2026-11-21T00:00:00.000Z",
"testimonialRespondedAt": null
}
- ✓New dashboard-generated API keys include testimonials:write. Existing keys retain their scopes; create a new key if yours lacks this permission.
- ✓A pending request can be updated and resent with a new idempotency key. This invalidates its earlier consent link. Approved or rejected requests are final and return 409.
- ✓Live mode emails the original booking contact. Test mode records the proposal without sending email. No consent token or review URL is returned.
- ✓Subscribe to feedback.testimonial_approved and feedback.testimonial_rejected for decisions. Webhook data includes the consent fields, decision timestamp, and updatedAt. Create a subscription for the new events; existing subscriptions are unchanged, and only decisions made after this feature is installed emit them.
- ✓Invalid input returns 400, missing or out-of-scope feedback returns 404, a missing write scope returns 403, and a send failure returns 503 with the previous proposal restored. Retry a failed send with the same idempotency key.