API
API Documentation (Beta)
✨ Welcome to our Beta API!
This feature is under active development. This means we may add new endpoints and features over time. We would love to hear your feedback, so if you need something specific, contact our support team.
What is Bolten's API?
Our REST API allows you to programmatically interact with your project's data in Bolten. With it, you can read, create, and update information, opening a world of possibilities for integrations and automations.
Common Use Cases
Create opportunities in Bolten from a form on your website.
Synchronize lead data with a Business Intelligence (BI) platform.
Integrate Bolten with other internal management systems (ERP).
Authentication and Authorization
Authentication to our API is done via an API Key.
Key per User: Each user in Bolten can have API keys that will be associated with their account.
Access: A project's key grants access to the resources available according to the permissions of the associated user. For example, if the user is a partner and has permission to access some component of a client's project, if the route exists in the API, the action in question can be performed.
How to generate an API key for partners?
In the partner area, go to the section API Keys and click the button in the upper right corner (+ API Key). After that, a field will appear below for you to name your key. Remember to use a name that makes sense for the use you will give it (for example, n8n key if it is used to integrate with n8n).
After that, click the Generatebutton. With that, the key will be created and displayed on the screen to be copied.
Copy and store the key at this time. After that it will no longer be retrievable.
Clicking the key value will automatically copy it to the clipboard.
If you need to delete the key, in the same panel, click the trash icon on the same row where it is listed.
How to Authenticate Requests?
You must send your API Key in the Authorization header of each request, using the Bearer.
Authorization: Bearer YOUR_PROJECT_SECRET_KEY
Example with CURL:
The Dynamic Structure of entities
One of Bolten's most powerful features is that the structure of some entities (their fields) is fully customizable per project. This means that before creating or updating an opportunity, contact, or deal, it is good practice to check which fields are available.
For this, use the endpoint that ends with /schema. It will return the exact structure of the fields configured in your project.
The components available in the API that use the dynamic structure are:
Opportunities (Opportunity Management/Kanban)
Contacts (Contact Management)
Golden Rule for Creation and Update
When sending data to the creation endpoints (POST) and update (PATCH):
If the name of a field in your JSON matches exactly the name of a field configured in the project, its value will be saved.
If a submitted field does not exist in the project, it will be silently ignored.
Last updated