Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

Overview

Introduction
Authentication
Response Body
Pagination
HTTP Status Codes
Errors

Accounts

Location
Organization
- The organization object
- Get an organization.get
User

Appointments

Appointment
- The appointment object
- Create an appointment.post

Campaigns

Campaign Interaction
- The campaign interaction object
- List campaign interactionsget
Campaign
Message
- Create a message for a given campaignpost

Contacts

Contact Attribute
Contact Tag
Contact

Conversations

Conversation
Conversation Assignee
- Get conversation assignees.get
- Update a conversation assignee.put

Feedback (Surveys)

Feedback
- The feedback object
- List all feedback surveys.get

Messenger

Message
Template

Payments

Invoice
Payment
- The payment object
- Get a payment.get
Reader
- The reader object
- Get a card reader.get
Refund

Products

Product
The Product Object
The Product Async Object
The Product Image Object

Reviews

Review
Review Invite
Review Sites Summary
- The review sites summary object
- Summary of all connected review sites.get
Review Summary
- The review summary object
- Summary of all reviewsget
Review Response
Review Attribution

Webhook Event Types

Message
Contact
- The contact webhook event object
Review
Invoice

Webhooks

Webhook

Workflows

Conversation
- Get a conversation lead ID.get
Data Feed Event
- The data feed event object
- Process an event through a data feed.post

SCIM

SCIM User

The Product Async Object

Product identifier

Attribute	Type	Description
identifier	string	Identifier of the product that can be used for retrieval

{
  "identifier": ""
}