RedCircle API integration

Add Zipcodes

Tool to add zipcodes to your RedCircle API account for geolocation targeting. Use when you need to localize product searches by specific postal codes. New zipcodes take approximately 2 minutes to become available after being added.

Clear Collection Requests

Tool to remove all requests from a specified collection. Collections can only be cleared when not actively running. Use when you need to empty a collection of all its requests.

Create Collection

Tool to create a new collection for running up to 15,000 requests on a schedule. Use when you need to organize and schedule batch requests with various scheduling patterns, priority levels, and notification methods.

Create Destination

Tool to create a new destination for uploading Collection Result Sets to cloud storage. Use when you need to configure a storage destination for result sets with providers like S3, GCS, Azure, OSS, or S3-compatible storage.

Create Requests

Tool to add up to 1,000 requests to an existing collection. Use when you need to populate a collection with product requests. Collections have a maximum of 15,000 requests (100 if include_html=true). Sequential calls required; parallel requests trigger HTTP 429 errors.

Delete Collection

Tool to remove a collection from the system by ID. Use when you need to delete a collection that is not currently running.

Delete Destination

Tool to remove a destination from your RedCircle API account. Use when you need to permanently delete a specific destination by its ID.

Delete Request from Collection

Tool to remove an individual request from a collection. Use when you need to delete a specific request from a collection by providing both collection_id and request_id. Collections must not be running during deletion.

Delete Requests In Bulk

Tool to delete multiple requests from a collection in bulk. Use when you need to remove multiple requests efficiently. Note: Requests can only be deleted when the collection is not running.

Delete Zipcodes

Tool to remove zipcodes from your RedCircle API account. Use when you need to delete specific zipcode/domain pairs from your account.

Get Account Information

Tool to retrieve account information, usage metrics, and platform status. Use when you need to check account credits, limits, plan details, or platform component status.

Get Collection

Tool to retrieve complete information about a specific collection. Use when you need detailed collection metadata including status, schedule, and configuration.