CRM Reference

Create, update, and manage deals including stage management and activity history.

• GET/api/v1/crm/deals— List deals
• POST/api/v1/crm/deals— Create a deal
• GET/api/v1/crm/deals/{id}— Get deal details
• PATCH/api/v1/crm/deals/{id}— Update a deal
• DELETE/api/v1/crm/deals/{id}— Delete a deal
• POST/api/v1/crm/deals/{id}/stage— Update deal stage
• GET/api/v1/crm/deals/{id}/activities— Get deal activities

Register and manage partner companies.

• GET/api/v1/crm/companies— List companies
• POST/api/v1/crm/companies— Create a company
• GET/api/v1/crm/companies/{id}— Get company details
• PATCH/api/v1/crm/companies/{id}— Update a company
• DELETE/api/v1/crm/companies/{id}— Delete a company

Manage contact information for partner companies.

• GET/api/v1/crm/contacts— List contacts
• GET/api/v1/crm/contacts/{id}— Get contact details
• POST/api/v1/crm/contacts— Create a contact
• PATCH/api/v1/crm/contacts/{id}— Update a contact
• DELETE/api/v1/crm/contacts/{id}— Delete a contact

Record activities (notes, calls, emails, etc.) associated with deals and contacts.

• GET/api/v1/crm/activities— List activities
• POST/api/v1/crm/activities— Create an activity
• PATCH/api/v1/crm/activities/{id}— Update an activity
• DELETE/api/v1/crm/activities/{id}— Delete an activity

Define and customize sales pipelines. Supports multiple pipelines (e.g., sales, partnerships).

• GET/api/v1/crm/pipelines— List pipelines
• POST/api/v1/crm/pipelines— Create a pipeline
• GET/api/v1/crm/pipelines/{id}— Get a pipeline
• PATCH/api/v1/crm/pipelines/{id}— Update a pipeline
• DELETE/api/v1/crm/pipelines/{id}— Delete a pipeline

Manage tags for deals, companies, and contacts. Filter resources by tags.

• GET/api/v1/crm/tags— List tags
• POST/api/v1/crm/tags— Create a tag
• PATCH/api/v1/crm/tags/{id}— Update a tag
• DELETE/api/v1/crm/tags/{id}— Delete a tag
• POST/api/v1/crm/tag-assignments— Assign a tag to a resource
• DELETE/api/v1/crm/tag-assignments/{tag_id}— Remove a tag from a resource

Add user-defined fields to deals, companies, and contacts. Supports text, number, date, and select field types.

• GET/api/v1/crm/custom-fields— List custom field definitions
• POST/api/v1/crm/custom-fields— Create a custom field definition
• PATCH/api/v1/crm/custom-fields/{id}— Update a custom field definition
• DELETE/api/v1/crm/custom-fields/{id}— Delete a custom field definition

Retrieve sales reports including pipeline forecasts, revenue projections, and stage distribution.

• GET/api/v1/crm/reports/pipeline-summary— Get pipeline summary
• GET/api/v1/crm/reports/forecast— Get revenue forecast
• GET/api/v1/crm/reports/owner-performance— Get performance by owner

Bulk stage changes, deletions, and CSV import/export for deals and contacts.

• POST/api/v1/crm/bulk/deals/update— Bulk update deals
• POST/api/v1/crm/bulk/deals/delete— Bulk delete deals
• POST/api/v1/crm/bulk/contacts/import— Import contacts from CSV
• GET/api/v1/crm/bulk/deals/export— Export deals to CSV
• GET/api/v1/crm/bulk/contacts/export— Export contacts to CSV
• GET/api/v1/crm/bulk/companies/export— Export companies to CSV

Retrieve operation history (create, update, delete, etc.) within the CRM domain.

• GET/api/v1/crm/audit-logs— List audit logs