Ploomes API: what you can do and how to use it with AI agents
Ploomes is a Brazilian CRM. Its API lets you read and write customers, contacts, deals, proposals, tasks and interactions. Brazilian B2B companies and integrators that connect Ploomes to an ERP and support use it. Access is through an integration user key generated in the account, on a REST API with OData-style queries.
What the Ploomes API offers
Customers and contacts
Companies and people, with standard and custom fields.
Deals
Opportunities, pipelines, stages and values.
Proposals and documents
Quotes and proposals generated from templates.
Tasks
Team activities with an owner and a due date.
Interactions
Contact records, such as calls, e-mails and meetings.
Webhooks
Notices of record creation and changes.
How to access the Ploomes API
- With your company’s credentialsA user key (User-Key) generated for an integration user in the Ploomes account, sent in the request header. Permissions follow that user's profile.
- The key inherits the user's permissions: use a dedicated, restricted profile.
- There are request limits: prefer webhooks to repeated queries.
- B2B contact data is also personal data under LGPD, Brazil's data-protection law.
Official documentation: developers.ploomes.com
What an iTeam agent does with the Ploomes API
Proposal sent and forgotten
The agent tracks proposals with no reply and follows up by e-mail in the rep's tone, logging the interaction on the deal.
Website lead straight into the pipeline
The form goes to the agent, which qualifies the lead, creates the customer and deal in Ploomes and books the executive's meeting.
Weekly forecast
Every Friday, the agent consolidates deals by stage and probability and sends them to the sales director, flagging those that changed stage.
After-sale kicked off
When a deal is won, the agent creates the implementation tasks and notifies the operations team.
From the credential to the agent at work, with approval
Create an integration user
In Ploomes, generate the User-Key of a user whose profile is limited to what the agents need.
Register the key in the iTeam vault
The key stays in the vault and each agent gets only the allowed actions, such as creating interactions without deleting deals.
Test with approval
Messages to customers and stage changes start with human approval.
Ready-made AI teams that use Ploomes
Questions about the Ploomes API
Is the Ploomes API free?
Generally, API access is part of the Ploomes subscription. Confirm the terms of your plan.
Do I need to code to use the Ploomes API with iTeam?
Not necessarily. iTeam's HTTP tool reads the documentation and the deployment team sets up the flows.
Can I filter deals by custom fields?
Yes, OData-style queries let you filter and expand fields, including custom ones.
