Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use Cases
  • Exclude Null Data in REST API Response to Improve Readability
  • Suppress Rules and Custom Processes
  • Work with Contacts to Reset Passwords, Send Mailings, and Run Marketing Campaigns
  • Run Analytics Reports to Evaluate Trends and Measure Effectiveness
  • Manage File Attachments
  • Manage Named IDs
  • Manage Named ID Hierarchies
  • Send on Save
  • Perform Bulk Extract
  • Perform Bulk Delete
  • Edit or Convert a Response Thread
• Learn More
  • Authenticate and Authorize
  • Work with your REST Client
    • Video: Introduction to the B2C Service REST API
    • Video: Access Resources via the REST API
  • Manage Collections
    • Run ROQL Object Queries
    • Run ROQL Tabular Queries
    • Query ROQL Managed Tables
    • Use Non-Query Operations
    • Video: Query via the REST API
  • Manage Custom Objects
  • Configure Cross-Origin Resource Sharing
  • Access Metadata
• Reference
  • API Throttling
  • Custom Headers
  • Error Codes
  • Error Exceptions
  • HTTP Tunneling
  • Resource Types
  • Status Codes
  • Supported Data Types
  • Supported HTTP Methods
  • Supported Media Types
  • Supported Query Parameters
  • Terminology
  • URL Path
  • Video: Use the REST API in Java
  • Video: Use the REST API in JavaScript
  • Video: Use the REST API in PHP
• Change History

Tasks

• Account Groups
  • Create an account group
  • Delete an account group
  • Get an account group
  • Get multiple account groups
  • Update an account group
• Accounts
  • Create an account
  • Delete an account
  • Get an account
  • Get multiple accounts
  • Update an account
• Analytics Report Results
  • Create an analytics report result
• Analytics Reports
  • Get an analytics report
  • Get multiple analytics reports
• Answer Versions
  • Delete an answer version
  • Get an answer version
  • Get multiple answer versions
  • Update an answer version
• Answers
  • Create an answer
  • Delete an answer
  • Get an answer
  • Get multiple answers
  • Update an answer
• Asset Statuses
  • Get an asset status
  • Get multiple asset statuses
• Assets
  • Create an asset
  • Delete an asset
  • Get an asset
  • Get multiple assets
  • Update an asset
• Bulk Extract Results
  • Delete a bulk extract result
  • Get a bulk extract result
  • Get multiple bulk extract results
• Bulk Extracts
  • Create a bulk extract
  • Delete a bulk extract
  • Get a bulk extract
  • Get multiple bulk extracts
  • Update a bulk extract
• Campaigns
  • Get a campaign
  • Get multiple campaigns
• Channel Types
  • Get a channel type
  • Get multiple channel types
• Chats
  • Get a chat
  • Get multiple chats
• Configurations
  • Get a configuration
  • Get multiple configurations
• Contact Marketing Rosters
  • Create a contact marketing roster
  • Delete a contact marketing roster
  • Get a contact marketing roster
  • Get multiple contact marketing rosters
  • Update a contact marketing roster
• Contacts
  • Create a contact
  • Delete a contact
  • Get a contact
  • Get multiple contacts
  • Reset password for a contact
  • Send a contact through a campaign flow starting at the specified entry point.
  • Send a transactional mailing to a contact
  • Update a contact
• Countries
  • Create a country
  • Delete a country
  • Get a country
  • Get multiple countries
  • Update a country
• Event Subscriptions
  • Create an event subscription
  • Delete an event subscription
  • Get an event subscription
  • Get multiple event subscriptions
  • Update an event subscription
• Holidays
  • Create a holiday
  • Delete a holiday
  • Get a holiday
  • Get multiple holidays
  • Update a holiday
• Incident Response
  • Create an incident response
• Incidents
  • Create an incident
  • Delete an incident
  • Get an incident
  • Get multiple incidents
  • Update an incident
• Mailboxes
  • Get a mailbox
  • Get multiple mailboxes
• Marketing Mailboxes
  • Get a marketing mailbox
  • Get multiple marketing mailboxes
• Message Bases
  • Get a message base
  • Get multiple message bases
• Named ID Hierarchies
  • Get a named ID hierarchy
  • Get all named ID hierarchy values
  • Get all resources having named ID hierarchies
• Named IDs
  • Get a named ID
  • Get all named ID values
  • Get all resources having named IDs
• Opportunities
  • Create an opportunity
  • Delete an opportunity
  • Get an opportunity
  • Get multiple opportunities
  • Update an opportunity
• Opportunity Statuses
  • Get an opportunity status
  • Get multiple opportunity statuses
• Organizations
  • Create an organization
  • Delete an organization
  • Get an organization
  • Get multiple organizations
  • Update an organization
• Purchased Products
  • Create a purchased product
  • Delete a purchased product
  • Get a purchased product
  • Get multiple purchased products
  • Update a purchased product
• Query Results
  • Get an array of ROQL results
• Sales Products
  • Create a sales product
  • Delete a sales product
  • Get a sales product
  • Get multiple sales products
  • Update a sales product
• Sales Territories
  • Create a sales territory
  • Delete a sales territory
  • Get a sales territory
  • Get multiple sales territories
  • Update a sales territory
• Service Categories
  • Create a service category
  • Delete a service category
  • Get a service category
  • Get multiple service categories
  • Update a service category
• Service Dispositions
  • Create a service disposition
  • Delete a service disposition
  • Get a service disposition
  • Get multiple service dispositions
  • Update a service disposition
• Service Mailboxes
  • Get a service mailbox
  • Get multiple service mailboxes
• Service Products
  • Create a service product
  • Delete a service product
  • Get a service product
  • Get multiple service products
  • Update a service product
• Site Interfaces
  • Get a site interface
  • Get multiple site interfaces
• SSO Token References
  • Get an SSO token reference
  • Get multiple SSO token references
  • Update an SSO token reference
• Standard Contents
  • Create a standard content
  • Delete a standard content
  • Get a standard content
  • Get multiple standard contents
  • Update a standard content
• Tasks
  • Create a task
  • Delete a task
  • Get a task
  • Get multiple tasks
  • Update a task
• Variables
  • Create a variable
  • Delete a variable
  • Get a variable
  • Get multiple variables
  • Update a variable