Welcome to Recerc Docs Admin Use Cases Customer Portal Getting Started Security at Recerc Webhooks Getting Started

Delete activity DELETE Create or update an activity POST List activities by object POST

Delete Agent DELETE Get Agent By Id GET Create Agent POST Find Many Agents POST Update Agent PUT

Query POST Workspace Query POST

Get Config GET Create Checkout Session POST Handle Checkout Status POST Create Portal Link POST

Get active cart GET Update cart comment PATCH Submit active cart POST Update cart line item PUT

Get public catalog GET Get current viewer access GET List viewer delivery addresses GET Request restricted catalog access POST Verify catalog user POST

Get Catalogs GET Get Catalog Products GET Get Catalog Data GET Get Catalog Settings GET Approve Access Request POST Reject Access Request POST Get Catalog Carts POST Create Catalog User POST Delete Catalog User POST Get Catalog Users POST Set Catalog PUT Set Catalog User State PUT

Context Delete DELETE Context Get Many GET Context Get By Id GET Get Conversation By Id GET Context Create POST History List POST Context Update PUT

Delete custom view DELETE List custom views GET Get custom view GET Save custom view PUT

Delete a customer DELETE Get a customer GET Get recent customers GET Search customers GET Update a single customer value PATCH Create a customer POST Query customers POST Update a customer PUT

List export jobs GET List export targets GET Create an export job POST

Get favorite status by ids POST Toggle favorite state POST Set favorite state PUT

Delete Order File DELETE Get Many GET Get Files For Order GET Add File Association POST Add Order File Association POST Confirm File Upload POST Create Presigned Url For Upload POST

Get home stats GET Send feedback POST

Get product media import job status GET Create product media import job POST Import products POST

Get Many GET Get GET Create Thread POST Run Agent POST Create Message POST

Get Kapso Customer GET Get Whatsapp Numbers GET Ensure Kapso Customer POST Update Whatsapp Integration Failure POST Update Whatsapp Integration Success POST Create Whatsapp Number POST Create Whatsapp Setup Link POST

Delete all custom objects by handle DELETE Delete a view DELETE Get recent objects by handle GET Search objects by handle GET Get an object record by handle and id GET List custom object definitions GET Get an object definition by handle GET Get an optional object definition by handle GET List native object definitions GET Get an object record by definition id and record id GET List views GET Get default object view config GET Get a view by id GET Update a single object field PATCH Resolve objects by ids POST Import object data POST Suggest object import mappings POST Create a custom object definition POST Query object records POST Create a custom object record POST Create many custom object records POST Create a view POST Update a custom object record by handle and id PUT Update an object definition PUT Save default object view config PUT Update a view PUT

Delete order DELETE Get order by id GET Get order item columns GET List order events GET Get snapshot URL GET Update order PATCH Update order field PATCH Create order POST Resolve order customer filter options POST Search order customer filter options POST Import an order from files or text POST Duplicate order POST Send a quote by email POST Query orders POST List order templates POST

Delete person DELETE Get person by id GET Update person field value PATCH Create person POST Query people POST Update person PUT

Delete price list DELETE Delete product price item DELETE Get price lists GET Get price items for list GET Get product price items GET Import price data POST Create or update price list POST Process uploaded price list file POST Set product price item PUT

Delete product list DELETE Create or update product list POST Query product lists POST

Product Recommendations

Get product recommendations POST

Delete product category DELETE Delete product DELETE Remove product document DELETE Remove product file association DELETE List product categories GET List products by category GET Get product filter options GET Search product filter options GET Get product by id GET Set product category PATCH Set product document technical specifications flag PATCH Create product POST Get products by ids POST Create product category POST Create product collection POST Add product to collection POST Activate product POST Archive product POST Add product document POST Add product file association POST Query products POST Search products POST Reindex workspace product search POST Update product category PUT Update product PUT

Delete report DELETE List reports GET Get report by handle GET Create report POST Invalidate report view cache POST Run report view POST Update report PUT

Remove order requirement template DELETE Get global agent prompt GET Get company settings GET Get customer table settings GET Get order requirements settings GET List my workspaces GET Get current workspace GET Get default workspace taxes GET Toggle order requirements PATCH Toggle order requirement template PATCH Add order requirement template POST Create workspace POST Save global agent prompt PUT Save company settings PUT Save order requirements settings PUT

Health check GET

Delete task DELETE Get task by id GET Update task PATCH Create task POST Bulk delete tasks POST Query tasks POST

Delete Template DELETE Create Template POST Load My Default Template POST Save My Default Template POST List Templates POST Resolve Effective Default Template POST Update Template PUT

Soft delete a workspace user DELETE Get current feature flags GET Get a workspace user GET List available workspace roles GET Search workspace users GET Set a current feature flag PATCH Update a workspace user PATCH Invite a workspace user POST Query workspace users POST Update workspace user roles PUT

Ingest a webhook event POST

List workflows GET Get workflow by id GET

Settings

Workspace settings, selection, defaults, and configuration endpoints served through Effect HttpApi.

Available Methods

Each method has its own page with request and response details, examples, and generated code snippets.

GET
/api/unstable/configs/agent-prompt
Get global agent prompt
PUT
/api/unstable/configs/agent-prompt
Save global agent prompt
GET
/api/unstable/configs/company
Get company settings
PUT
/api/unstable/configs/company
Save company settings
GET
/api/unstable/configs/customers-table
Get customer table settings
GET
/api/unstable/configs/order-requirements
Get order requirements settings
PUT
/api/unstable/configs/order-requirements
Save order requirements settings
PATCH
/api/unstable/configs/order-requirements/enabled
Toggle order requirements
POST
/api/unstable/configs/order-requirements/templates
Add order requirement template
DELETE
/api/unstable/configs/order-requirements/templates/{templateId}
Remove order requirement template
PATCH
/api/unstable/configs/order-requirements/templates/{templateId}/enabled
Toggle order requirement template
GET
/api/unstable/workspaces
List my workspaces
POST
/api/unstable/workspaces
Create workspace
GET
/api/unstable/workspaces/current
Get current workspace
GET
/api/unstable/workspaces/default-taxes
Get default workspace taxes

Update report PUT

Updates a custom report owned by the current workspace user.

Remove order requirement template DELETE

Deletes the order requirement template identified by templateId.