Jump to Content

Home Sandbox Accounts API App Studio Webhooks Community

Home App Studio API Latest Updates Community

API

Jump to Content

Home App Studio API Latest Updates Community

All

Pages

Start typing to search…

Getting Started

Overview
Authentication
Base URL
Change Log
Errors
HTTP Methods
Pagination, Ordering, and Filtering
Rate Limits
Schema
Side Loading
Tips
Requests and Feedback

API Guides

Contact Custom Objects API Guide
Contact Custom Fields API Guide
Contact Event Tracking API Guide

Accounts

Accounts
Account Contact Association
Custom Account Fields
Custom Account Field Values

Addresses

Addresses

Automations

Automations

Branding

Branding

Calendar Feeds

Calendar Feeds

Campaigns

Campaigns
Messages
Variables

Contacts

Contacts
Automations
Custom Fields
Custom Field Values
Email (emailActivities)
- List all email activitiesget
Tags
- Add a tag to contactpost
- Remove a tag from a contactdel

Custom Objects

Custom Object schemas
Parent and Child Schemas
- Create a public schemapost
- Create a child schemapost
Managing Records
Paging, Ordering, Sorting, and Filtering

Deals

Deals
Pipelines
Stages
Custom Deal Fields
Custom Deal Field Values
Secondary Contacts
Deal Roles

DeepData Integrations

Connections
E-Commerce Customers
E-Commerce Orders
E-Commerce Abandoned Carts
E-Commerce Order Products

EcomMerce graphQl api

Overview
- About the GraphQL API
Reference

Forms

Forms

Lists

Lists

Notes

Notes

Saved Responses

Saved Responses

Scores

Scores
- Retrieve a scoreget
- List all scoresget

Segments

Segments
Saved Segment Summaries
- List Summaries for Saved Segmentsget
- Retrieve a Saved Segment's Summaryget
Match One
- Create a Match One Requestget
- Check to see if a Contact matches a Segment using the given externalIdget
Match All
Most Recent Count History
- Retrieve the most recent result count for the given segments that were ran without an AdditionalCriteriaget
Count History
- Retrieve all result counts for the given segment that were ran without an AdditionalCriteriaget
- Retrieve all result counts for the given segment that were ran without an AdditionalCriteriaget

Settings

Settings
- Update settingsput

Site & Event Tracking

Event Tracking
Site Tracking

Tags

Tags

Tasks

Tasks

Task Outcomes

Task Outcomes

Task Types

Task Types

Task Types and Outcomes Relations

Task Types and Outcomes Relations

Task Reminders:Notifications

Task Reminders/Notifications
- Create a task reminderpost

Templates

Templates
- Retrieve a templateget

Users

Users
Groups

Webhooks

Webhooks

WhatsApp API

Templates
Flows
Conversations

SMS Broadcast API

Broadcasts
AI
Metrics
Failures
- Get broadcast failure detailsget
Recipients
- Get broadcast recipientsget
- Export broadcast recipientspost

Stages

Stages are a way to group deals within a pipeline. A pipeline can have any number of stages within it and each stage can have any number of deals within it.