Welcome to our API reference!
This is the reference documentation for the Sirena REST API. This API is based on resources which are represented by JSON format and are manipulated using the HTTP protocol.
And much more...
Before using this API you will need:
In Sirena, a lead is a piece of information that allows an agent to contact a potential client. To be useful, this information should include:
A contact or prospect can be added to Sirena in two ways:
API Keys enable access to the API with one or more Scopes. Each API Scope enables set of API features.
||Send lead data for agents to work with.|
||Read prospects, operations and quotes.|
||Read prospects and quote additional data.|
||Create new quotes, update quotes, delete prospects, etc.|
||Subscribe to notifications via webhooks.|
||List available conversational channels for prospects.|
||Send transactional messages like appointment information, delivery and shipping notifications.|
||Send conversational messages for automatic replies, chatbots, and other use cases.|
||Perform operations as a user.|
API Rate Limits are in place to protect Sirena from API traffic spikes that could put our databases at risk. We therefore measure the amount of requests sent to the API in order to throttle these when they surpass the amount allowed. We will respond with
429 Too Many Requests and the following headers:
|Header Name||Header Description|
|X-RateLimit-Limit||Maximum number of requests allowed for the app.|
|X-RateLimit-Remaining||Number of requests left in the current time.|
|X-RateLimit-Reset||Time when the number of requests will be reset to the maximum limit.|
The amount of permitted requests resets every 60 seconds
The following endpoints allow creating and registering Leads. Leads include information about the product or service of interest, which means different lead schemas depending on the industry.
Processes lead data and returns the matching prospect. If the prospect already exists, previous lead data will not be returned. Retail industry only.
The priority of the Lead
The name/key to identify the provider of the lead.
The ID of the lead in the provider.
Identify the advertiser, site, publication, etc. that is sending traffic to your property.
The advertising or marketing medium.
The individual campaign name, slogan, promo code, etc. for a product.
Array of strings
Array of strings <email>
@deprecated use NewCallEvent An object representing an inbound phone call. Connected calls should provide a recording and its associated metadata.
The category of the lead. Use the Categories endpoint to see the available categories. If skipped, the default category is used.
Array of objects (Nin)
National Identification Number
Full street address.
County / other sub-division of a locality, such as communes departments, etc.
City / Municipality.
State / Province.
Zip Code / Postal Code.
The title of the listing page.
The URL of the listing page.
Any comments worth making to the agent, from the lead or from the acquisition channel.
If the lead has an assigned company, indicate it's name or code. Usually, it's the name of the company under the general account.
If the lead has an assigned store, indicate it's name or code. Usually is the name of the branch inside the company.
If the lead has an assigned agent, indicate it's name or code.
@deprecated - use providerLeadId The ID of the lead in the provider.
@deprecated - use utmSource Identify the advertiser, site, publication, etc. that is sending traffic to your property.
@deprecated - use utmMedium The contact medium where the lead came from.
@deprecated - use utmCampaign The individual campaign name, slogan, promo code, etc. for a product.
Array of objects (NewEvent)
Ordered list of lead events