Reviewflowz API Get an API key

Send review requests from your CRM or booking system

You end up with a review request going out each time a customer's visit, job or order is done in your own software. You see what happened to every request, and an unsubscribe on either side reaches the other.

Run calls

Sign in to run every call on this page on your account's data. No key needed.

Check the integrations first. The app lists 600+ booking, job, CRM and payment systems under Integrations → Automate Review Requests. If yours connects there, nothing in this guide is needed.

Before you start

  • A key with requests:write and webhooks:write. Requests go to real customers: build with your own email and phone as the contact first.
  • The API is part of the Premium plan (see pricing). API-only plans start at $300 a month: book a 30-minute call for a custom quote. Review requests are part of the Pro plan, which Premium includes.

The example follows one business, the Eiffel Tower in Paris. Its booking system knows when each visit is over.

1. Build the campaign in the app

Open Requests in the app and create a campaign once: the channel, the message and its follow-ups, the review link it sends people to, and when it sends. Name it after what puts customers in it, like "Visits completed in our booking system" or "Sales closed in our CRM", so each campaign says where its customers come from. Everything after this is code.

2. Check it is ready

curl https://api.reviewflowz.com/v3/campaigns \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/campaigns in the reference

Example answer
{"next_cursor": null,"has_more": false,"data": [{"id": "cmp_7","name": "Visits completed in our booking system","channel": "email","state": "draft","segment": "seg_1","magic_link": "lnk_1","send_delay_minutes": 120,"throttle": null,"messages": [{"position": 1,"channel": "email","subject": "How was your visit?","body": "Hi {{first_name}}, thanks for visiting today. Could you take a minute to tell others how it went?","cta_text": "Leave a review","sender": "Sofia @ Tour Eiffel","reply_to": "hello@yourcompany.com","delay_minutes": 120,"complete": true},{"position": 2,"channel": "email","subject": "Re: How was your visit?","body": "Hi {{first_name}}, in case you missed our last message: a minute is all it takes to tell others how your visit went.","cta_text": "Leave a review","sender": "Sofia @ Tour Eiffel","reply_to": "hello@yourcompany.com","delay_minutes": 4320,"complete": true}],"ready": true,"blockers": [],"created_at": "2026-11-01T09:00:00Z"}]}​

messages is the sequence you built: the first message and each follow-up, with its wait in delay_minutes. Here, the first email goes 2 hours after the customer is added, and a reminder 3 days after that. ready: true and an empty blockers mean nothing is missing. Otherwise blockers says what to finish in the app. Keep the campaign's id (cmp_7 here).

3. Add a customer when the visit is done

This is the call your system makes each time it marks a visit done. Build it with your own email as the contact, and wait for step 7 before adding real customers: a customer added before the campaign is on never gets its request.

Add the visitor. Send up to 100 people per call. Send their name too: it fills {{first_name}} in the message.

curl https://api.reviewflowz.com/v3/campaigns/cmp_7/contacts \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-d '{"contacts": [{"email": "maya.chen@example.com", "first_name": "Maya", "last_name": "Chen"}],"confirm": true}'
Edit the request

POST /v3/campaigns/{id}/contacts in the reference

Example answer
{"data": [{"contact": "con_00000000-0000-4000-8000-000000000001","sends": true}]}​

Keep each contact id on the customer's record in your system: steps 4 to 6 use it. An email or phone we already know finds the same contact.

"confirm": true says you mean to message them. Without it, the call adds nobody and answers 409 confirmation_required with sends: each row that would get a request, by index, and its timing:

  • now: the request goes out right away.
  • delayed: it waits the campaign's delay.
  • quiet_hours: a text waits for hours when the customer can be texted.
  • held: the account has never sent a request. The first ones wait until someone confirms the first send on the Requests page in the app.

The call is all or nothing. If one row is wrong, nobody is added and the answer is 422 validation_failed, with errors naming each row, like contacts[0].email. A customer already in the campaign is one of those errors, and so is the same person twice in one call: leave them out and send the call again.

A row with "sends": false was added but gets no request. unreachable says why when the campaign is on, like no_email, no_phone, unsubscribed or already_invited (they had this campaign's request before).

4. Follow each request

Subscribe your server to the request events:

curl https://api.reviewflowz.com/v3/webhook-endpoints \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-d '{"url": "https://hooks.yourcompany.com/reviewflowz","events": ["invitation.sent", "invitation.clicked", "invitation.skipped", "invitation.failed", "contact.opted_out"]}'
Edit the request

POST /v3/webhook-endpoints in the reference

  • invitation.sent: a request went out. data.channel says how.
  • invitation.clicked: the customer opened the request's link.
  • invitation.skipped: a request was not sent. data.reason says why, like unsubscribed or no_phone. Its object carries the contact and the message's step.
  • invitation.failed: the request bounced or could not be delivered. data.reason says how.

Without a server, or to check one customer, list their requests:

curl "https://api.reviewflowz.com/v3/invitations?contact=con_00000000-0000-4000-8000-000000000001" \-H "Authorization: Bearer rfz_live_..."
Edit the request

GET /v3/invitations in the reference

Example answer
{"next_cursor": null,"has_more": false,"data": [{"id": "inv_00000000-0000-4000-8000-000000000001","contact": "con_00000000-0000-4000-8000-000000000001","campaign": "cmp_7","channel": "email","state": "clicked","location": "loc_1","sent_at": "2026-11-10T09:00:05Z","delivered_at": "2026-11-10T09:00:07Z","opened_at": "2026-11-10T09:14:22Z","clicked_at": "2026-11-10T09:14:40Z","reviewed_at": null,"failed_at": null,"open_count": 1,"click_count": 1,"created_at": "2026-11-10T09:00:04Z"}]}​

Each message sent is one row. state is the furthest it got: pending, sent, delivered, opened, clicked, reviewed, failed or opted_out (marked as spam). reviewed means the customer filled in the review form the request linked to. To see it, read state or reviewed_at here.

When a review on one of your sources is matched to the customer by their name, the follow-ups still waiting are not sent. Each one comes as invitation.skipped with reason: already_reviewed.

5. Write it back to your CRM

Every request event carries the request, with its contact id from step 3. Find the customer by that id and save the state, sent_at, clicked_at and reviewed_at on their record. On invitation.skipped, the contact is in data.object.contact.id.

6. Keep unsubscribes in step

contact.opted_out tells you a customer unsubscribed. data.channel is email or sms, and the object is the contact, with its email and phone. Mark them in your CRM.

When a customer unsubscribes in your CRM, send it here. They get no more requests on that channel, from any campaign.

curl https://api.reviewflowz.com/v3/opt-outs \-H "Authorization: Bearer rfz_live_..." \-H "Content-Type: application/json" \-d '{"email": "maya.chen@example.com"}'
Edit the request

POST /v3/opt-outs in the reference

Example answer
{"id": "opt_00000000-0000-4000-8000-000000000001","contact": "con_00000000-0000-4000-8000-000000000001","email": "maya.chen@example.com","phone": "+14155550100","channels": {"email": "2026-11-12T16:20:00Z","sms": "2026-11-12T16:20:00Z"}}​

channels says since when each channel is opted out. Without channels in the call, as here, it covers email and texts; send "channels": ["email"] for one. Someone we don't know yet is added as a contact, so the opt-out holds if they come later. An opt-out you send also comes back as contact.opted_out: skip it when your CRM already has it.

7. Turn it on

curl -X POST https://api.reviewflowz.com/v3/campaigns/cmp_7/activate \-H "Authorization: Bearer rfz_live_..."
Edit the request

POST /v3/campaigns/{id}/activate in the reference

Example answer
{"id": "cmp_7","name": "Visits completed in our booking system","channel": "email","state": "active","ready": true,"blockers": []}​

Turn it on last, once your code from steps 3 to 6 is ready. state: active means requests are on: from now on, each customer your system adds gets one. Customers added before this get none.

When it can't turn on yet, the answer says why:

  • 202 with "activation": "pending_credits": the saved card was charged for credits. Requests turn on by themselves when they land.
  • 402 payment_action_required: the card needs to confirm the payment. Open hosted_invoice_url, then call again.
  • 402 credits_required: the account has no credits for this channel. Buy credits in the app, or turn on auto-recharge.
  • 409 campaign_incomplete: finish what blockers lists in the app, then call again.
  • 409 sms_setup_required: finish setting up text messages in the app (Settings → Request sending).
  • 409 under_review: sending is being checked for this account. We email you when it's cleared.

What it costs and where it stops

  • Emails and texts are paid from the account's credits for that channel. With auto-recharge on, turning a campaign on can charge the saved card (step 7).
  • 100 people per call. A customer gets a campaign's request once. Rate limits.
  • On an account that has never sent a request, the first send is confirmed in the app (step 3).

When something else fits better

Look for your software among the 600+ systems the app lists under Integrations → Automate Review Requests. If yours connects there, connecting it adds each customer for you, with no code.