Home
Scopes
OAuth 2.0
Get Access Token
Get Location Access Token from Agency Token
Schemas
Objects
Object Schema
Get Object Schema by key / id
Update Object Schema By Key / Id
Get all objects for a location
Create Custom Object
Records
Get Record By Id
Update Record
Delete Record
Create Record
Search Object Records
Search Object Records
Shemas
Schemas
Business
Business API
Update Business
Delete Business
Get Business
Get Business By Location
Create Business
Schemas
Calendars
Calendars
Get Free Slots
Update Calendar
Get Calendar
Delete Calendar
Get Calendars
Create Calendar
Calendar Groups
Get Groups
Create Calendar Group
Validate group slug POST
Delete Group
Update Group
Disable Group
Calendar Events
Create appointment
Update Appointment
Get Appointment
Get Calendar Events
Get Blocked Slots
Create Block Slot
Update Block Slot
Delete Event
Appointment Notes
Get Notes
Create Note
Update Note
Delete Note
Calendar Nitifications
Get notifications
Create notification
Update notification
Delete Event Notification
Shemas
Schemas
Companies
Companies API
GET Company
Schemas
Campaigns
Campaigns API
GET Campaigns
Schemas
Contacts
Contacts API
GET Contacts
Update Contact
Delete Contact
Upsert Contact
Get Contacts By BusinessId
Create Contact
Search Contacts
Tasks
Get all Tasks
Create Task
Get Task
Update Task
Delete Task
Update Task Completed
Appointments
Get Appointments for Contact
Tags
Add Tags
Remove Tags
Notes
Get All Notes
Create Note
Get Note
Update Note
Delete Note
Campaigns
Add Contact to Campaign
Remove Contact from Campaign
Remove Contact From Every Campaign
Workflow
Add Contact to Workflow
Remove Contact from Workflow
Bulk
Update Contacts Tags
Add/Remove Contacts From Business
Search
Search Contacts
Get Duplicate Contact
Followers
Add Followers
Remove Followers
Associations
Association s API
Get association key by key name
Get association by object keys
Update Association By Id
Delete Association
Get association by ID
Create Association
Get all associations for a sub-account / location
Relations
Create Relation for you associated entities.
Get all relations By record Id
Delete Relation
Schemas
Schemas
Custom Fields
Custom Fields API
Get Custom Field / Folder By Id
Update Custom Field By Id
Delete Custom Field By Id
Get Custom Fields By Object Key
Create Custom Field Folder
Update Custom Field Folder Name
Delete Custom Field Folder
Create Custom Field
Schemas
Schemas
Conversations
Conversations API
Get Conversation
Update Conversation
Delete Conversation
Create Conversation
Search
Search Conversations
Email
Get email by Id
Cancel a scheduled email message.
Messages
Get message by message id
Get messages by conversation id
Send a new message
Add an inbound message
Add an external outbound call
Cancel a scheduled message.
Upload file attachments
Get Recording by Message ID
Get transcription by Message ID
Download transcription by Message ID
Download transcription by Message ID
Providers
Agent/Ai-Bot is typing a message indicator for live chat
Schemas
Schemas
Courses
Import Courses
Schemas
Emails
Campaigns
Get Campaigns
Templates
Create a new template
Fetch email templates
Delete a template
Update a template
Schemas
Schemas
Forms
Forms API
Get Forms Submissions
Upload files to custom fields
Get Forms
Schemas
Schemas
Invoices
Invoices API
Generate Invoice Number
Get invoice
Update invoice
Delete invoice
Update invoice late fees configuration
Void invoice
Send invoice
Record a manual payment for an invoice
Update invoice last visited at
Create Invoice
List invoices
Templates
Create template
List templates
Get an template
Update template
Delete template
Update template late fees configuration
Schedule
Create Invoice Schedule
List schedules
Get an schedule
Update schedule
Delete schedule
Text2pay
Create & Send
Schemas
Schemas
Trigger Links
Trigger LInks API
Update Link
Delete Link
Get Links
Create Link
Sub-Account (Formerly location)
Sub-Account (Formerly location) API
Custom Field
Get Custom Fields
Create Custom Field
Get Custom Field
Update Custom Field
Uploads File to customFields
Custom Value
Get Custom Values
Create Custom Value
Get Custom Value
Update Custom Value
Delete Custom Value
Template
GET all or email/sms templates
DELETE an email/sms template
Search
Search
Sub-Account (Formerly Location)
Get Sub-Account (Formerly Location)
Put Sub-Account (Formerly Location)
Delete Sub-Account (Formerly Location)
Create Sub-Account (Formerly Location)
Task Search
Task Search Filter
Users
Users API
Get User
Update User
Delete User
Get User by Location
Create User
Search
Search Users
Workflows
Workflows API
Get Workflow
Social Planner
Social Media Posting API
Get Workflow
Oauth | Google
Starts OAuth For Google Account
Get google business locations
Set google business locations
Oauth | Facebook
Starts OAuth For Facebook Account
Get Facebook pages
Attach Facebook pages
Oauth | Instagram
Starts OAuth For Instagram Account
Get Instagram Professional Accounts
Attach Instagram Professional Accounts
Webhook Events
AppointmentCreate
AppointmentDelete
AppointmentUpdate
AppUninstall
ExternalAuthConnected
CampaignStatusUpdate
ContactCreate
ContactDelete
ContactDndUpdate
ContactTagUpdate
Conversation Provider Outbound
Conversation Unread Webhook
InvoiceCreate
InvoiceSent
InvoiceVoid
InvoicePartiallyPaid
InvoiceDelete
InvoiceUpdate
LCEmailStats
LocationCreate
LocationUpdate
NoteDelete
NoteUpdate
OpportunityAssignedToUpdate
OpportunityCreate
OpportunityDelete
OpportunityMonetaryValueUpdate
OpportunityStageUpdate
OpportunityUpdate
OrderCreate
OrderStatusUpdate
OutboundMessage
PlanChange
PriceCreate
PriceUpdate
PriceDelete
ProductCreate
ProductUpdate
ProductDelete
TaskComplete
TaskCreate
TaskDelete
UserCreate
ObjectSchemaCreate
ObjectSchemaUpdate
RecordCreate
RecordUpdate
RecordDelete
RelationCreate
RelationDelete
AssociationUpdate
AssociationCreate
AssociationDelete
Search for:
Home
CampusAdmin Integration APIs
Welcome to the CampusAdmin Integration docs.
The APIs use OAuth 2.0 for authentication.
