{"info":{"_postman_id":"5ab5b5f1-7776-4bde-b4cc-40386f0f86ff","name":"Zceppa Public API","description":"

To use our Rest API with your application, one has to partner with Zceppa and onboard their business. Once you are a customer of Zceppa, you can obtain an API key by contacting the admin through support@zceppa.com.

Below are the key parameters required to use the API:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
{{base_url}}	Base URL for the API request. For production use, the base URL is https://api.zceppa.com
{{apikey}}	You can obtain your API key from this location: https://app.zceppa.com/api-docs

","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"20930473","collectionId":"5ab5b5f1-7776-4bde-b4cc-40386f0f86ff","publishedId":"2sA3kSmhZA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-18T07:28:29.000Z"},"item":[{"name":"Review","item":[{"name":"Send Review Request","id":"60ac3e1c-48ef-484d-bda3-7c4bb57bb507","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"apikey","value":"{{apikey}}","description":"

API key generated from Zceppa app

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"John\",\n \"phone_number\": \"9090XXXXX\",\n \"email_id\": \"john.doe@email.com\",\n \"request_type\": \"SMS\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseurl}}/v1/review/request/send","description":"

This endpoint allows your application to send review requests through different channels such as SMS, Email, or WhatsApp.

Visit demo here

Below are the parameters required:

Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
first_name	First name of the customer to whom we are sending the review request.
last_name	(Optional) Last name of the customer.
phone_number	Phone number of the customer.
email_id	(Optional) Email ID of the customer; this is mandatory when the request_type is EMAIL.
request_type	Preferred channel through which the customer will receive the review request. Possible values are SMS, EMAIL, WHATSAPP.

Response

200 - When API returns success

Example: { \"message\": \"Review Request Sent Successfully.\" }

400 - Validation or input data error. Verify you are passing the correct input data and retry again.

Example: { \"message\": \"Invalid mobile number\" }

500 - Internal server error. Retry after 60 seconds and the issue still persists contact Zceppa support

\n","urlObject":{"path":["v1","review","request","send"],"host":["{{baseurl}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60ac3e1c-48ef-484d-bda3-7c4bb57bb507"}],"id":"693bbaee-f05b-43ee-bfd5-9c2969ad32ee","description":"

Zceppa helps brands collect reviews across platforms using different channels

Currently supported platforms:

Google
Facebook
Zceppa (Internal review platform)

Supported channels to collect / request reviews:

\n","_postman_id":"693bbaee-f05b-43ee-bfd5-9c2969ad32ee"}],"event":[{"listen":"prerequest","script":{"id":"3e5c9125-f8ce-4784-ad4c-a0de77743801","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"81023fb7-74e9-4f2e-b030-f2565551341e","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"{{apikey}}","value":"{{apikey}}","type":"string"},{"key":"{{baseurl}}","value":"","type":"string"},{"key":"apikey","value":"{{apikey}}"}]}