All Endpoints

Base URL: https://app.beeving.com/api/v1. The API has 141 endpoints, listed below. Every request needs a token.

Contacts

Reference →

Method	Path
GET	/contacts
POST	/contacts
GET	/contacts/{id}
PUT	/contacts/{id}
DELETE	/contacts/{id}
GET	/contacts/{id}/timeline
POST	/contacts/{id}/unsubscribe
POST	/contacts/bulk-create
PUT	/contacts/bulk-update
DELETE	/contacts/bulk-delete
POST	/contacts/import
GET	/contacts/export

Lists

Reference →

Method	Path
GET	/lists
POST	/lists
GET	/lists/{id}
PUT	/lists/{id}
DELETE	/lists/{id}
GET	/lists/{id}/contacts
POST	/lists/{id}/contacts
DELETE	/lists/{id}/contacts

Tags

Reference →

Method	Path
GET	/tags
POST	/tags
GET	/tags/{id}
PUT	/tags/{id}
DELETE	/tags/{id}
GET	/tags/{id}/contacts
POST	/tags/{id}/contacts

Segments

Reference →

Method	Path
GET	/segments
POST	/segments
GET	/segments/{id}
PUT	/segments/{id}
DELETE	/segments/{id}
GET	/segments/{id}/contacts
GET	/segments/{id}/preview

Blacklist

Reference →

Method	Path
GET	/blacklist
POST	/blacklist
GET	/blacklist/reasons
POST	/blacklist/check
POST	/blacklist/bulk-create
DELETE	/blacklist/bulk-delete
GET	/blacklist/{id}
DELETE	/blacklist/{email}

Campaigns

Reference →

Method	Path
GET	/campaigns
POST	/campaigns
GET	/campaigns/{id}
PUT	/campaigns/{id}
POST	/campaigns/{id}/start
POST	/campaigns/{id}/pause
POST	/campaigns/{id}/resume
POST	/campaigns/{id}/duplicate
GET	/campaigns/{id}/stats
GET	/campaigns/{id}/analytics
GET	/campaigns/{id}/timeline
GET	/campaigns/{id}/export

Campaign steps

Reference →

Method	Path
GET	/campaigns/{id}/steps
POST	/campaigns/{id}/steps
POST	/campaigns/{id}/steps/bulk-update
POST	/campaigns/{id}/steps/reorder
GET	/campaigns/{id}/steps/{step}
PUT	/campaigns/{id}/steps/{step}
DELETE	/campaigns/{id}/steps/{step}

Campaign contacts

Reference →

Method	Path
GET	/campaigns/{id}/contacts
POST	/campaigns/{id}/contacts
POST	/campaigns/{id}/contacts/enroll-from-lists
GET	/campaigns/{id}/contacts/{contact}
DELETE	/campaigns/{id}/contacts/{contact}
POST	/campaigns/{id}/contacts/{contact}/skip

Templates & marketplace

Reference →

Method	Path
GET	/templates
POST	/templates
GET	/templates/{id}
PUT	/templates/{id}
DELETE	/templates/{id}
POST	/templates/{id}/preview
GET	/templates/{id}/variables
POST	/templates/{id}/duplicate
GET	/marketplace/templates
GET	/marketplace/templates/{id}
POST	/marketplace/templates/{id}/copy

Email accounts

Reference →

Method	Path
GET	/email-accounts
POST	/email-accounts
GET	/email-accounts/{id}
PUT	/email-accounts/{id}
DELETE	/email-accounts/{id}
POST	/email-accounts/{id}/test
POST	/email-accounts/{id}/set-default
GET	/email-accounts/{id}/stats
POST	/email-accounts/{id}/reset-counter

Analytics

Reference →

Method	Path
GET	/analytics/dashboard
GET	/analytics/emails-sent
GET	/analytics/performance
GET	/analytics/top-campaigns

CRM: Companies

Reference →

Method	Path
GET	/crm/companies
POST	/crm/companies
GET	/crm/companies/{id}
PUT	/crm/companies/{id}
DELETE	/crm/companies/{id}
GET	/crm/companies/{id}/contacts
GET	/crm/companies/{id}/deals

CRM: Deals

Reference →

Method	Path
GET	/crm/deals
POST	/crm/deals
GET	/crm/deals/{id}
PUT	/crm/deals/{id}
DELETE	/crm/deals/{id}
POST	/crm/deals/{id}/won
POST	/crm/deals/{id}/lost

CRM: Pipeline

Reference →

Method	Path
GET	/crm/pipeline
POST	/crm/pipeline
POST	/crm/pipeline/reorder
PUT	/crm/pipeline/{id}
DELETE	/crm/pipeline/{id}

CRM: Tasks

Reference →

Method	Path
GET	/crm/tasks
POST	/crm/tasks
GET	/crm/tasks/{id}
PUT	/crm/tasks/{id}
DELETE	/crm/tasks/{id}
POST	/crm/tasks/{id}/complete

Webhooks

Reference →

Method	Path
GET	/webhooks
POST	/webhooks
GET	/webhooks/{id}
PUT	/webhooks/{id}
DELETE	/webhooks/{id}
POST	/webhooks/{id}/test
GET	/webhooks/{id}/logs
POST	/webhooks/{id}/regenerate-secret

API tokens

Reference →

Method	Path
GET	/api-tokens
POST	/api-tokens
GET	/api-tokens/permissions
GET	/api-tokens/{id}
PUT	/api-tokens/{id}
DELETE	/api-tokens/{id}

Workspace

Reference →

Method	Path
GET	/workspace
GET	/workspace/members
GET	/workspace/invitations