This is the complete reference of the RapBooster platform API, generated from the same OpenAPI document as @rapbooster/sdk. Each endpoint lists its key scope, parameters, request body, responses and schemas, with curl, JavaScript and Python samples. Paste a test key to send a real request from this page.
Review a delivered product (status pending until moderated)
Stablepublishable or secret key with storefrontX-Buyer-Token
Only a product of the buyer's own delivered order (403 REVIEW_NOT_ALLOWED), once per order and product (409 REVIEW_EXISTS); photos are the buyer's review uploads (400 REVIEW_UPLOAD_INVALID). Title and body are plain text.
Stablepublishable or secret key with storefrontX-Buyer-Token
The GSTIN must pass the format and mod-36 check and name the address's state (400 TRADE_GSTIN_INVALID, details.reason). A second application while one is open is 409 TRADE_ALREADY_APPLIED; after a rejection the buyer may apply again.
Is the PIN code served, the fee, free-above and the ETA
Stablepublishable or secret key with storefront
With cart_id the fee and ETA are for that cart (its goods total and weight); else for weight_g (or the store's default weight) and the base fee. 422 PINCODE_NOT_SERVICEABLE when no courier serves it.
From phone_number_id or the campaign default number; the key's creator must have access to that number. Delivery updates arrive as message.status webhooks.
List quotes, proformas and tax invoices (filters, q = number or buyer)
Betascope billing:read
Own + team (RP26) unless the role has Everyone (billing:sales-reach-all): documents credited to the caller or below them, else created by them. With leadId (the lead page) every document of the lead.
Parameters
Name
In
Type
About
id
query
string
Snowflake ID
q
query
string
Search Query
page
query
integer
limit
query
integer
sort
query
"ASC" | "DESC"
Sort direction. Defaults per endpoint — usually DESC.
List leads (newest first by default; q, status_id, type, view filters; sortBy). Scoped to the caller's own / team leads, except that an exact phone or email in q finds any lead (LT119); leads of a type the caller lacks the key of never show (R36-45)
Betascope crm:read
Parameters
Name
In
Type
About
id
query
string
Snowflake ID
q
query
string
Search Query
page
query
integer
limit
query
integer
sort
query
"ASC" | "DESC"
Sort direction. Defaults per endpoint — usually DESC.
Field to order by. Unrecognised values fall back to this endpoint default. Default: created_at (newest first); the NEWLY_ASSIGNED / GRABBED views: owner_changed_at (oldest first).
status_id
query
string
A lead status id (GET leads/lead-statuses).
vip
query
boolean
Deprecated (R36-45): use type. true = type=vip, false = every type but VIP. Removed in the next release.
type
query
LeadType[]
R36-45: only leads of these types (repeat the param or comma-separate). Types hidden from the caller never show either way.
view
query
LeadView
A ready-made filter. Views over invoices, tickets or catalogue sales return nothing to a caller who can't read that app.
owner
query
string[]
Only leads these users own (assigned_user_id; repeat the param or comma-separate); none adds the leads nobody owns. Narrows inside the caller's lead scope, never widens it (plan 16, SPF18; plan 21, YP84).
stage
query
LeadStage
Only leads the data currently puts at this stage (negotiation for Performance).
open
query
boolean
Only leads in an open status category (true): not won, lost or given up.
pending
query
"demo" | "manager_call"
Leads with work waiting on pending_for: demo (a scheduled demo or meeting ahead) or manager_call (a pending manager request asked of them). Needs pending_for.
pending_for
query
string
The member pending is about. Required with pending, 400 otherwise.
external_account_id
query
string
Exact match on external_account_id.
source
query
string[]
crm_lead_source ids (any of).
interest
query
string[]
Interested in items, as <item_type>:<item_id> (any of), e.g. saas-tools:12 or custom:3.
city
query
string[]
City of the default billing detail (any of).
state
query
string[]
State of the default billing detail (any of).
tag
query
string[]
crm_lead_contact_tag ids: leads with a person tagged with any of them.
lead_tag
query
string[]
crm_lead_tag ids (GET leads/lead-tags): leads tagged with any of them (OC11).
created_from
query
string
Created on or after this day (workspace timezone).
created_to
query
string
Created on or before this day.
activity_from
query
string
Last activity on or after this day.
activity_to
query
string
Last activity on or before this day.
followup
query
"overdue" | "today" | "week" | "none"
Pending follow-up: overdue, due today, due within 7 days, or none.
Billed at least this much (minor units). Needs Sales access.
billed_max
query
integer
Billed at most this much (minor units).
due_min
query
integer
Unpaid at least this much (minor units). Needs Sales access.
due_max
query
integer
Unpaid at most this much (minor units).
renewal_product
query
string[]
Renewal items by product (plan 30 RV1), any of: <item_type> (desktop-tools, saas-tools, domain-tlds, hosting-plans, services, custom for free-text lines) or <item_type>:<item_id>. On a renewal view only the items it lists count. Needs Sales access.
renewal_ends_from
query
string
A renewal item ends on or after this day (workspace timezone, RV1).
renewal_ends_to
query
string
… on or before this day.
sold_through
query
string
R36-45: only the customers sold through this Reseller lead (their sold_through). Not stored in saved views.
Send a site form (contact, service, corporate gifting, trade, franchise, careers)
Stable
One lead per phone: a new one in the Enquiries pool, or the phone's existing lead (its owner gets a follow-up). Tagged per kind. With a publishable key: reCAPTCHA token required (captcha_token or X-Recaptcha-Token, 403 CAPTCHA_FAILED), 5 an hour per IP and 3 per phone (429 ENQUIRY_RATE_LIMITED), and no lead id in the answer.
Needs verified_token from applications/otp/verify for the same phone (403 PHONE_NOT_VERIFIED; single use). The CV is checked by its bytes (400 CV_NOT_PDF, CV_TOO_LARGE, CV_REQUIRED). The applicant appears in HRMS › Recruitment with the CV; a second application by the same email to the same role answers the first one (created false).
Opt a person in to an Audience group, with the consent they gave
Stable
A known phone or email is that person (added to the group); else a new contact. Consent source, time and IP are stamped on the contact. 404 GROUP_NOT_FOUND.
Schedule (a time, the next queue slot, or now), or send for approval
Betascope marketing:write
With Posts need approval on, a member without Publish directly sends it for approval (awaiting_approval: true); so does every call made with an API key (keys have no publish scope). 400 SOCIAL_POST_INVALID (details.problems), SOCIAL_NO_TARGETS, SOCIAL_SCHEDULE_IN_PAST; 409 SOCIAL_ACCOUNT_UNAVAILABLE, SOCIAL_QUEUE_FULL.
Everything not RESOLVED or CLOSED — the working queue.
priority
query
"LOW" | "NORMAL" | "HIGH" | "URGENT"
category_id
query
string
assigned
query
string
me, none, or a member's user id.
lead_id
query
string
source
query
"MANUAL" | "WHATSAPP" | "EMAIL" | "PRODUCT"
unanswered
query
boolean
Nobody has replied publicly yet.
conversation_id
query
string
Tickets from this WhatsApp conversation.
wal_chat_id
query
string
Plan 29: tickets from this linked WhatsApp chat.
sla
query
"late"
late: breaching SLA now (the Breaching SLA view): not RESOLVED or CLOSED, and a first-reply or resolve target missed. Matches nothing while SLA is off.
Event names from GET webhook-events (e.g. lead.created, lead.updated, message.status).
url required
string
CreatedWebhookEndpointDto object
CreatedWebhookEndpointDto fields
Field
Type
About
created_at required
string (date-time)
disabled_at
string (date-time) | null
disabled_reason
"failing" | "manual" | null
events required
string[]
Event names from GET webhook-events (e.g. lead.created, lead.updated, message.status).
failing_since
string (date-time) | null
Failing without a success since then; 3 days of it turn the endpoint off.
failure_count required
number
Failed attempts since the last success.
id required
string
is_enabled required
boolean
last_delivered_at
string (date-time) | null
last_failure_at
string (date-time) | null
previous_secret_expires_at
string (date-time) | null
After a rotation: the old secret also signs until then.
secret required
string
The signing secret (whsec_…), shown only in this response. Each delivery carries X-RapBooster-Signature: t=<unix>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">.
url required
string
CreditNoteDto object
CreditNoteDto fields
Field
Type
About
cess_minor required
number
Plan 32: the lines' compensation cess (in total_minor).
cgst_minor required
number
credit_given_minor
number
Plan 29 CB4: the customer credit it made (minor units); 0 = the money was kept. Absent on a credit note issued before that release with nothing backfilled.
PB4: the credited line's catalogue type and period; absent on free text.
qty required
number
sgst_minor required
number
tax_category required
"taxable" | "nil" | "exempt" | "non_gst"
Plan 32: the credited line's GST category.
tax_minor required
number
tax_name
string
Simple tax: the credited line's named rate.
taxable_minor required
number
total_minor required
number
CreditNoteSummaryDto object
CreditNoteSummaryDto fields
Field
Type
About
cgst_minor required
number
credit_given_minor
number
Plan 29 CB4: the customer credit it made (minor units); 0 = the money was kept. Absent on a credit note issued before that release with nothing backfilled.
Stock always moves as deltas (each side's sales are kept).
GroupUsageDto object
GroupUsageDto fields
Field
Type
About
campaigns required
number
drips required
number
email_campaigns required
number
email_sequences required
number
total required
number
InvoiceAcceptanceDto object
InvoiceAcceptanceDto fields
Field
Type
About
action required
"ACCEPT" | "DECLINE" | "REQUEST_CHANGES"
created_at required
string
document_hash required
string
sha256 of the document as shown.
full_name required
string
The typed full name (the signature).
id required
string
ip
string
note
string
Decline reason or the changes asked for.
proforma_id
string
The proforma an Accept & pay created.
user_agent
string
InvoiceBuyerDto object
InvoiceBuyerDto fields
Field
Type
About
address_line1
string
address_line2
string
billing_name required
string
city
string
country_code
string
email
string
gstin
string
lead_name required
string
phone
string
postal_code
string
state
string
InvoiceDiscountCheckDto object
InvoiceDiscountCheckDto fields
Field
Type
About
above_cap required
boolean
approval_pending
boolean
A discount request on this document or an ancestor awaits a decision.
approved_pct
number
The highest discount %, approved (billing.sales.discount_over_cap) on this document or an ancestor.
blocked required
boolean
Issuing is refused (409 INVOICES_DISCOUNT_ABOVE_CAP) until the discount is approved.
cap_pct required
number
The creator's cap, % (empty = 0).
pct required
number
Line + document discounts (+ the incl.-tax switch, PB5) ÷ gross, %.
price_override_minor required
number
DI-2: what catalogue lines priced below the catalogue took off (qty × difference), minor units; counted in pct against the catalogue gross.
tax_switch_minor required
number
PB5: what switching catalogue lines from plus tax to incl. tax took off, minor units.
InvoiceDiscountViewDto object
InvoiceDiscountViewDto fields
Field
Type
About
type required
"PERCENT" | "AMOUNT"
value required
number
InvoiceDto object
InvoiceDto fields
Field
Type
About
allow_part_payment required
boolean
B15: the pay link accepts part of what's due.
amended_at
string
R36-14 (GST): a tax invoice whose billing details changed after the month it was paid (approved); the GST report lists it as amended (GSTR-1). Absent = never.
amount_due_minor required
number
amount_paid_minor required
number
asked_price_minor
number
Proformas from the lead wizard: the price the buyer asked for, minor units (LT54), shown next to the quoted total.
auto_issued
boolean
Plan 31 (PR-DA1): issued by the approval of its discount request, not by hand. Absent = false.
auto_source
"renewal" | "recurring" | "system"
P35-26: what raised it: renewal (the renewal sweep), recurring (a schedule), system (a checkout, purchase or plan change). Absent = a member.
billing_edit
"direct" | "approval"
R36-14, issued / paid tax invoices: changing the billing details applies now (direct: in the month it was paid, or issued if unpaid) or needs approval and is listed as amended in GSTR-1 (approval: an earlier month). Absent on other documents or with an e-invoice IRN.
R36-45: the buyer lead's type, for the VIP / VVIP badge (document header; plan 37: the list rows too). Absent without a lead.
min_part_percent required
number
Least part payment, % of what's due (0 = any amount).
needs_attention required
boolean
Overpaid, or a paid line the catalogue refused.
notes
string
number
string
overpaid_minor required
number
Paid beyond the total (flagged, never auto-refunded).
owner_change_pending
boolean
P35-30: a change of this sale's owner waits for approval (on any document of the sale). Absent when none.
paid_at
string
parent_id
string
pay_gateway
"RAZORPAY" | "STRIPE" | "PAYTM" | "CCAVENUE"
A7.10.3: the gateway override; absent = the workspace default.
pay_link required
string
The public pay/view link (V10).
payment_mode required
"PREPAID" | "COD"
Plan 21 (YP153): COD opens the goods order at issue; cash recorded on delivery.
payment_pending
boolean
P35-8: a payment recorded on this document waits for approval (billing.payments.entry). R36-12: more parts may still be recorded, together at most what is due. Absent when none.
Plan 32 (RX-D29): "Reverse charge applies": no output tax charged, the buyer pays it.
revisable required
boolean
R36-14: an issued quote (issued, accepted, declined, changes requested, expired) or an issued proforma with nothing paid: PUT with revise: true saves a new revision.
revised_at
string
R36-14: when the last revision was saved. Absent = never.
revision required
number
R36-14: 1 as first issued; each revision of an issued quote / proforma adds one.
F10: absent on documents from before registrations.
taxable_minor required
number
terms
string
total_minor required
number
updated_at required
string
InvoiceEinvoiceDto object
InvoiceEinvoiceDto fields
Field
Type
About
ack_date
string
ack_no
string
ewb_date
string
ewb_no
string
e-way bill number.
ewb_valid_till
string
imported_at required
string
irn
string
Invoice reference number (IRN).
signed_qr
string
RX-10: the IRP's signed QR (a JWT), printed on the PDF once acked; absent before the ack.
InvoiceItemDto object
InvoiceItemDto fields
Field
Type
About
billing_period
string
catalogue_tax_inclusive
boolean
PB5: the catalogue price's own incl.-tax setting (absent on free text and older lines).
catalogue_unit_price_minor
number
DI-2: the catalogue's unit price when the line was saved (catalogue lines); unit_price_minor below it counts against the discount cap. Absent on free-text lines and older rows.
cess_minor required
number
Compensation cess charged (in total_minor, not tax_minor).
cess_rate_bp required
number
Compensation cess, basis points (100 = 1%).
cgst_minor required
number
credited_qty
number
Tax invoices (plan 34, Q2): quantity already credited by issued credit notes; a new credit note may take at most qty − credited_qty of this line. Absent = none credited.
cancel (cancel the quote / proforma), terms (part-payment terms or gateway), tax_invoice (issue the tax invoice now), credit_note, billing (billing details after a payment, BD1) or delete (delete the quote / proforma, P35-25).
request_id required
string
The billing.sales.invoice approval request it waits in.
InvoiceReminderDto object
InvoiceReminderDto fields
Field
Type
About
channel required
"EMAIL" | "WHATSAPP"
error
string
Why it didn't go out.
id required
string
offset_days required
number
Days from the due date; negative = before.
sent_at required
string
InvoiceSellerViewDto object
InvoiceSellerViewDto fields
Field
Type
About
address
string
country_code
string
display_name
string
Business profile trade name (N6.5); absent: print name.
email
string
gstin
string
The tax ID (a GSTIN, or what tax_id_label names).
lut_fy
string
lut_number
string
F12: the LUT a without-payment export was issued under.
name required
string
phone
string
state
string
tax_id_label
string
The tax ID's label ("GSTIN", "VAT No."); also the buyer's.
tax_system
"INDIA_GST" | "SIMPLE"
Absent on older documents: INDIA_GST.
website
string
InvoiceSummaryDto object
InvoiceSummaryDto fields
Field
Type
About
allow_part_payment required
boolean
B15: the pay link accepts part of what's due.
amended_at
string
R36-14 (GST): a tax invoice whose billing details changed after the month it was paid (approved); the GST report lists it as amended (GSTR-1). Absent = never.
amount_due_minor required
number
amount_paid_minor required
number
auto_source
"renewal" | "recurring" | "system"
P35-26: what raised it: renewal (the renewal sweep), recurring (a schedule), system (a checkout, purchase or plan change). Absent = a member.
R36-45: the buyer lead's type, for the VIP / VVIP badge (document header; plan 37: the list rows too). Absent without a lead.
min_part_percent required
number
Least part payment, % of what's due (0 = any amount).
needs_attention required
boolean
Overpaid, or a paid line the catalogue refused.
notes
string
number
string
overpaid_minor required
number
Paid beyond the total (flagged, never auto-refunded).
paid_at
string
parent_id
string
pay_gateway
"RAZORPAY" | "STRIPE" | "PAYTM" | "CCAVENUE"
A7.10.3: the gateway override; absent = the workspace default.
pay_link required
string
The public pay/view link (V10).
payment_mode required
"PREPAID" | "COD"
Plan 21 (YP153): COD opens the goods order at issue; cash recorded on delivery.
place_of_supply
string
GST documents: the buyer's state, e.g. "Rajasthan (08)".
place_of_supply_unknown
boolean
GST document whose buyer state is unknown: it was charged as intra-state.
port_code
string
reminders_paused required
boolean
B31: payment reminders paused for this document.
response_unseen required
boolean
B23: a buyer answered and no member had opened it yet.
reverse_charge required
boolean
Plan 32 (RX-D29): "Reverse charge applies": no output tax charged, the buyer pays it.
revisable required
boolean
R36-14: an issued quote (issued, accepted, declined, changes requested, expired) or an issued proforma with nothing paid: PUT with revise: true saves a new revision.
revised_at
string
R36-14: when the last revision was saved. Absent = never.
revision required
number
R36-14: 1 as first issued; each revision of an issued quote / proforma adds one.
BI1: catalogue items bought on the lead's paid / part-paid tax invoices that are still live (the header's "N active" chip; records section purchased_items).
assigned_user_id
string | null
Owner (central user id).
assignee_name
string | null
city
string | null
Plan 31: the lead's city.
country_code
string | null
ISO-3166 alpha-2.
created_at required
string (date-time)
created_by
string | null
Central user id.
customer
boolean | null
Has an active sale: the Customer badge (LT15). Lists and the lead page.
Set when the edit changed an existing mobile / email without crm.edit_contact_details: that part waits in this crm.contact_detail_change request; the rest was saved.
email
string | null
external_account_deleted_at
string (date-time) | null
Master tenant only: when the linked workspace was deleted (SA-17).
Set while the latest owner change is a give-up with no follow-up since (LT17).
id required
string
in_reach
boolean
P35-8: the caller may change this lead (PM5 reach). Outside reach the lead page offers only what stays open (sends, pins, demos, Grab, comments, a new follow-up).
interest_names
string[]
Leads list only (R36-16): the lead's Interested in names (catalogue items and custom values).
R36-45: Standard, Reseller, Affiliate, VIP or VVIP (Reseller / Affiliate only in RapBooster's own workspace). A lead of a type whose key the caller lacks is never returned.
updated_at required
string (date-time)
LeadDto object
LeadDto fields
Field
Type
About
assigned_user_id
string | null
Owner (central user id).
assignee_name
string | null
city
string | null
Plan 31: the lead's city.
country_code
string | null
ISO-3166 alpha-2.
created_at required
string (date-time)
created_by
string | null
Central user id.
customer
boolean | null
Has an active sale: the Customer badge (LT15). Lists and the lead page.
default_billing_id required
string
email
string | null
external_account_deleted_at
string (date-time) | null
Master tenant only: when the linked workspace was deleted (SA-17).
external_account_id
string | null
id required
string
interest_names
string[]
Leads list only (R36-16): the lead's Interested in names (catalogue items and custom values).
is_vip required
boolean
Deprecated (R36-45): type is vip or vvip. Removed in the next release.
last_activity_at
string (date-time) | null
Lists only: the latest note, call, email, chat, follow-up or status change.
mobile
string | null
name required
string
next_followup_at
string (date-time) | null
Lists only: the soonest pending follow-up.
next_followup_id
string | null
Newly assigned / Grabbed lists only (plan 29 N): the soonest pending follow-up's id.
owner_change_from_name
string | null
That previous owner's name.
owner_change_from_user_id
string | null
Grabbed list: the previous owner (central user id); absent = nobody (a given-up lead from the treasure box).
owner_change_kind
"ASSIGN" | "GRAB" | "HANDOVER" | null
Newly assigned / Grabbed lists only: how it got its owner (absent = created already owned).
owner_changed_at
string (date-time) | null
Newly assigned / Grabbed lists only: when the lead got its current owner (the latest owner change, else its creation).
R36-45: Standard, Reseller, Affiliate, VIP or VVIP (Reseller / Affiliate only in RapBooster's own workspace). A lead of a type whose key the caller lacks is never returned.
R36-45: Standard, Reseller, Affiliate, VIP or VVIP (Reseller / Affiliate only in RapBooster's own workspace). A lead of a type whose key the caller lacks is never returned.
Groups to put the person in (on update: exactly these).
name
string | null
phone
string | null
With its calling code (+91…), or give country_code.
PublicCreateLeadDto object
PublicCreateLeadDto fields
Field
Type
About
city
string | null
contact_name
string | null
The lead's first contact person (LP12). Default: the lead's name.
country_code
string | null
ISO-3166 alpha-2.
email
string | null
mobile
string | null
name required
string
source_id
string | null
A lead source id.
state
string | null
An Indian state's name when country_code is IN, free text otherwise.
status
string
A lead status name from the workspace's list (Leads settings › Statuses), any case. Default: the workspace's default status.
PublicLeadDto object
PublicLeadDto fields
Field
Type
About
assigned_user_id
string | null
city
string | null
country_code
string | null
ISO-3166 alpha-2.
created_at required
string (date-time)
email
string | null
id required
string
mobile
string | null
name required
string
source_id
string | null
state
string | null
status
string | null
The status's name.
status_category
"open" | "won" | "lost" | "given_up" | null
What the status means: open, won, lost or given up.
updated_at required
string (date-time)
PublicMessageDto object
PublicMessageDto fields
Field
Type
About
channel required
"whatsapp" | "email"
delivered_at
string (date-time) | null
error
string | null
id required
string
WhatsApp: Meta's message id; email: ours.
number_id
string
WhatsApp send only: the number it went from.
sender
"official" | "linked"
WhatsApp send only: which sender carried it.
sent_at
string (date-time) | null
status required
string
sent, or queued on a linked number's paced queue.
test
boolean
True on a test key's dry-run send: nothing was sent and no credits were used.
PublicSendEmailDto object
PublicSendEmailDto fields
Field
Type
About
connection_id
string | null
Default: the system one.
html
string | null
Default: text as HTML.
subject required
string
text required
string
Plain-text body.
to required
string
PublicSendWhatsappDto object
PublicSendWhatsappDto fields
Field
Type
About
channel
"official" | "linked" | "auto"
official: Meta's number (default). linked: a linked number, which sends the template's text version. auto: the sender rule set for the API purpose in WhatsApp settings.
language
string | null
number_id
string | null
The number to send from: Meta's phone-number id, or a linked number's id with channellinked / auto. Replaces phone_number_id.
params
Record<string, string>
Template variables by position (1, 2, …) or name.
phone_number_id
string | null
Meta's phone-number id to send from (default: the campaign default).
template_id required
string
The approved template's Meta id.
to required
string
PublicUpdateLeadDto object
PublicUpdateLeadDto fields
Field
Type
About
city
string | null
country_code
string | null
ISO-3166 alpha-2.
email
string | null
mobile
string | null
name
string
state
string | null
An Indian state's name when country_code is IN, free text otherwise.
status
string
A lead status name from the workspace's list (Leads settings › Statuses), any case.
created_at + the priority's resolve target. Absent when SLA is off or no target.
resolved_at
string (date-time) | null
resolved_by
string | null
sla_state
"ok" | "due_soon" | "late" | null
The worse of the two clocks: late = a target was missed (stays so after a late reply), due_soon = a running clock has 20% or less of its target left, else ok. A first public reply stops the first-reply clock; resolving or closing stops both. Absent when SLA is off or the priority has no target.
created_at + the priority's resolve target. Absent when SLA is off or no target.
resolved_at
string (date-time) | null
sla_state
"ok" | "due_soon" | "late" | null
The worse of the two clocks: late = a target was missed (stays so after a late reply), due_soon = a running clock has 20% or less of its target left, else ok. A first public reply stops the first-reply clock; resolving or closing stops both. Absent when SLA is off or the priority has no target.