Jump to Content
Home
Sandbox Accounts
API Documentation
App Studio
Webhooks
Community
Home
Guides
Recipes
API Documentation
Latest Updates
Home
Sandbox Accounts
API Documentation
App Studio
Webhooks
Community
API Documentation
API Documentation
Delete a group
Search
JUMP TO
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
Create an account
post
Update an account
put
Retrieve an account
get
Delete an account
delete
List all accounts
get
Create an account note
post
Update an account note
put
Bulk delete accounts
delete
Account Contact Association
Create an association
post
Retrieve an association
get
Update an association
put
Delete an association
delete
List all associations
get
Custom Account Fields
Create a custom field
post
Retrieve a custom field
get
Update a custom field
put
Delete a custom field
delete
List all custom fields
get
Custom Account Field Values
Create a custom field value
post
Bulk create a custom account field value
post
Retrieve a custom field value
get
Update a custom field value
put
Delete a custom field value
delete
List all custom field values
get
Bulk update a custom field value
patch
Addresses
Addresses
Create an address
post
Retrieve an address
get
Update an address
put
Delete an address
delete
Delete address associated with a specific user group
delete
Delete address associated with a specific list
delete
List all addresses
get
Automations
Automations
List all automations
get
Branding
Branding
Retrieve a branding
get
Update a branding
put
List all brandings
get
Calendar Feeds
Calendar Feeds
Create a calendar feed
post
Retrieve a calendar feed
get
Update a calendar feed
put
Delete a calendar feed
delete
List all calendar feeds
get
Campaigns
Campaigns
Create Shareable Campaign Template Link
get
List all campaigns
get
Retrieve links associated to campaign
get
Retrieve a campaign
get
Edit campaign
put
Create Campaign
post
Duplicate Campaign
post
Messages
Create a message
post
Retrieve a message
get
Update a message
put
Delete a message
delete
List all messages
get
Variables
List Variables
get
Retrieve a Variable
get
Create a Variable
post
Edit a Variable
put
Delete a Variable
delete
Bulk Delete Variables
delete
Contacts
Contacts
Create a contact
post
Sync a contact's data
post
Retrieve a contact
get
Update list status for a contact
post
Update a contact
put
Delete a contact
delete
List, search, and filter contacts
get
List all automations the contact is in
get
Retrieve a contact's score value
get
Bulk import contacts
post
Bulk import status list
get
Bulk import status info
get
List a contact's activities
get
Retrieve a contact's bounce logs
get
Retrieve a contact's data
get
Retrieve a contact's goals
get
Retrieve a contact's list memberships
get
Retrieve a contact's logs
get
Retrieve a list of contact's deals
get
Retrieve a contact's deals
get
Retrieve a contact's field values
get
Retrieve a contacts list of geo-ips
get
Retrieve a contacts geo IP address
get
Retrieve a contacts notes
get
Retrieve list of all notes
get
Retrieve a contacts organization
get
Retrieve a contacts plus append
get
Retrieve a contacts tracking logs
get
Retrieve a contacts account contacts
get
Retrieve a contacts automation entry counts
get
Automations
Add a contact to an automation
post
Retrieve an automation a contact is in
get
Remove a contact from an automation
delete
List all automations a contact is in
get
Custom Fields
Create a custom field
post
Add Custom Field to Field Group
post
Delete Custom Field Field Group
delete
Update a custom field
put
Get a custom field by ID
get
Get All Custom Field Groups
get
Get Custom Field Group by ID
get
Update Custom Field Field Group
put
Delete a custom field
delete
List all custom fields
get
Create a custom field relationship to list(s)
post
Create custom field options
post
Delete a custom field relationship to list(s)
delete
Custom Field Values
Create a custom field value
post
Retrieve a custom field value
get
Update a custom field value for contact
put
Delete a custom field value
delete
List all custom field values
get
Email (emailActivities)
List all email activities
get
Tags
Add a tag to contact
post
Remove a tag from a contact
delete
Custom Objects
Custom Object schemas
List all schemas
get
Retrieve a schema
get
Create a schema
post
Update a schema
put
Delete a schema
delete
Delete a field
delete
Parent and Child Schemas
Create a public schema
post
Create a child schema
post
Managing Records
List records by schema
get
Create or update record
post
Get a record by id
get
Get a record by external id
get
Delete a record by id
delete
Delete a record by external ID
delete
Paging, Ordering, Sorting, and Filtering
Deals
Deals
Create a deal
post
Retrieve a deal
get
Update a deal
put
Delete a deal
delete
List all deals
get
Create a deal note
post
Update a deal note
put
Bulk Update Deal Owners
patch
List all deal activities
get
Pipelines
Create a pipeline
post
Retrieve a pipeline
get
Update a pipeline
put
Delete a pipeline
delete
List all pipelines
get
Stages
Create a stage
post
Retrieve a stage
get
Update a stage
put
Delete a stage
delete
List all stages
get
Move deals to another stage
put
Custom Deal Fields
Create a custom field meta
post
Retrieve a custom field
get
Update a custom field
put
Delete a custom field
delete
List all custom fields
get
Custom Deal Field Values
Create a custom field value
post
Bulk create a custom deal field value
post
Retrieve a custom field value
get
Update a custom field value
put
Bulk update a custom field value
patch
Delete a custom field value
delete
List all custom field values
get
Secondary Contacts
Create a secondary contact
post
Retrieve a secondary contact
get
Update a secondary contact
put
Delete a secondary contact
delete
List all secondary contacts
get
Deal Roles
List all deal roles
get
Create a deal role
post
Delete a deal role
delete
DeepData Integrations
Connections
Create a connection
post
Retrieve a connection
get
Update a connection
put
Delete a connection
delete
List all connections
get
E-Commerce Customers
Create a customer
post
Retrieve a customer
get
Update a customer
put
Delete a customer
delete
List all customers
get
E-Commerce Orders
Create an order
post
Retrieve an order
get
Update an order
put
Delete an order
delete
List all orders
get
E-Commerce Abandoned Carts
E-Commerce Order Products
List EcomOrderProducts
get
List EcomOrderProducts for a Specific EcomOrder
get
Retrieve an EcomOrderProduct
get
EcomMerce graphQl api
Overview
About the GraphQL API
Reference
Searches
Orders
Recurring Payments
Shared Objects
Products
Browse Abandonment Developer Overview
Browse Session APIs
Forms
Forms
Retrieve a form
get
List all forms
get
Lists
Lists
Create a list
post
Retrieve a list
get
Delete a list
delete
Retrieve all lists
get
Create a list group permission
post
Notes
Notes
Create a note
post
Retrieve a note
get
Update a note
put
Delete a note
delete
Saved Responses
Saved Responses
Create a saved response
post
Retrieve a saved response
get
Update a saved response
put
Delete a saved response
delete
List all saved responses
get
Scores
Scores
Retrieve a score
get
List all scores
get
Segments
Segments
Retrieve a segment
get
List all segments
get
Settings
Settings
Update settings
put
Site & Event Tracking
Event Tracking
Track event
post
Create a new event (name only)
post
Retrieve Event Tracking Status
get
Enable/disable
put
Delete event (name only)
delete
List all events (names only)
get
Get Contact's Tracking Logs/Events
get
Get Contact By Event ID
get
Site Tracking
Add domain to whitelist
post
Retrieve site tracking code
get
Retrieve status
get
Enable/disable
put
Remove domain from whitelist
delete
List all whitelisted domains
get
Tags
Tags
Create a tag
post
Retrieve a tag
get
Update a tag
put
Delete a Tag
delete
List all tags
get
Tasks
Tasks
Create a task
post
Retrieve a task
get
Update a task
put
Delete a task
delete
List all tasks
get
Task Outcomes
Task Outcomes
Create a task outcome
post
Retrieve a task outcome
get
Update a task outcome
put
Delete a task outcome
delete
List all task outcomes
get
Task Types
Task Types
Create a task type
post
Retrieve a task type
get
Update a task type
put
Delete a task type
delete
List all task types
get
Move tasks to another task type
put
Task Types and Outcomes Relations
Task Types and Outcomes Relations
Retrieve a task type - outcome relation
get
Delete a task type - outcome relation
delete
List all task type - outcome relations
get
Task Reminders/Notifications
Task Reminders/Notifications
Create a task reminder
post
Templates
Templates
Retrieve a template
get
Users
Users
Create a user
post
Retrieve a user
get
Retrieve a user by email
get
Retrieve a user by username
get
Retrieve logged-in user
get
Update a user
put
Delete a user
delete
List all users
get
Groups
Create a group
post
Retrieve a group
get
Update a group
put
Delete a group
delete
List all groups
get
List All Group Limits
get
Webhooks
Webhooks
Create a webhook
post
Retrieve a webhook
get
Update a webhook
put
Delete a webhook
delete
List all webhooks
get
List all webhook events
get
Webhook Payloads
Delete a group
delete
https://{youraccountname}.api-us1.com/api/3/groups/
{id}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https://
youraccountname
.api-us1.com/api/3
/groups/{id}
Otomatik - 104.16.241.118
CloudFlare DNS
Türk Telekom DNS
Google DNS
Open DNS
OSZAR »
