Constant
Contact

API Docs API SDKs API Reference My Applications

Release Notes Features Exclusive to the V3 API

Introduction to the V3 API Using the Developer Portal Quick Start Guide Rate Limits

Data Migration Overview Contacts V3 Changes and Migration Lists V3 Changes and Migration Email Campaign V3 Changes and Migration

OAuth2 Overview OAuth2 Authorization Code Flow OAuth2 PKCE Flow OAuth2 Device Flow OAuth2 Implicit Flow Update Your Applications to Use the New Authorization Service

Authorization Scopes Overview User Roles and Privileges Overview

Account Services Overview Get Account Summary Details PUT (update) Account Summary Details GET the Physical Address for the Account PUT (update) the Physical Address for the Account Add the Physical Address for the Account Add an Account Email Address Get a Collection of Account Emails Get User Privileges

Bulk Activity Overview Get the Status of a Bulk Activity Import Contacts Export Contacts to a CSV File Delete Contacts Bulk Activity How to Add Contacts to Lists Remove Contacts from Lists Bulk Activity Delete Contact Lists Bulk Activity Delete Custom Fields Bulk Activity Add Tags to Contacts Bulk Activity Remove Tags from Contacts Bulk Activity Delete Tags Bulk Activity

Contacts Quick Start Guide Contact Resource Get a Contact's Details Get a Contacts Collection Creating New Contacts Create a Single Contact Update a Single Contact's Details Create or Update a Contact Using a Single Method Get Contact Consent Counts Autoresponder and Confirmed Opt-in Emails Delete a Contact Sync Contacts and Lists Unsubscribe and Resubscribe Contacts Get Contact SMS Engagement Details

Custom Fields Overview Create and Update Custom Fields Get Custom Fields Delete a Custom Field Add Custom Field Data to a Contact

Contact Lists Overview Get a Contact List Get All Contact Lists Create a Contact List Update a Contact List Delete a Contact List

Tags Overview Get a Tag's Details Get Details about all Tags Create a Tag Rename a Tag Delete a Tag

Contact Activity Reporting Overview Get Activity Summary Get Activity Details Get Open and Click Rates

Email Campaign Overview Email Campaign Quick Start Guide Create an Email Campaign Designing HTML for Custom Code Emails Get a Collection of Email Campaigns Get Details for a Single Email Campaign Get an Email Campaign Activity Update an Email Campaign Activity Schedule an Email Campaign Activity Get the Schedule of an Email Campaign Activity Unschedule an Email Campaign Activity Get an HTML Preview of an Email Campaign Activity Test Send an Email Campaign Activity Rename an Email Campaign Get Email Campaign Activity Send History Delete an Email Campaign Post (Schedule) a Resend to Non-openers Email Campaign Activity Get Details for a Resend to Non-openers Email Campaign Activity Delete (Unschedule) a Resend to Non-openers Email Campaign Activity

Email Campaign Activities A/B Tests Overview Get A/B Test Details for an Email Campaign Activity Create an A/B Test for an Email Campaign Activity Delete an A/B Test for an Email Campaign Activity

Email Reporting Overview Get an Email Campaign Activity Sends Report Get an Opens Report for an Email Campaign Activity Get an Email Unique Opens Report Get a Clicks Report for an Email Campaign Activity Get an Email Did Not Opens Report Get an Email Forwards Report Get an Email Opt-outs Report Get an Email Links Report Get an Email Bounces Report Get an Email Campaign Stats Report Get an Email Campaign Activities Stats Report Get an Email Campaigns Summary Report

Events Overview Events Schema Registration Schema Get Details for a Single Event Get Details for All Events Get Details for One Event Registration Get All Registration Details for an Event Create a New Event Update an Event Copy an Existing Event Check In Event Tickets Undo Event Ticket Check-In Update Registration Status Update Registration Payment Status

Get a Collection of Social Profiles Get a Collection of Social Network Connections Get a Collection of Hashtag Groups Create a Social Media Post

Segments Overview Create a Segment Get All Segments Get a Segment's Details Delete a Segment Update a Segment Rename a Segment

Landing Pages Reporting Overview Get a Unique Contact Clicks Landing Page Report Get a Contacts Opens Landing Page Report Get a Unique Contact Opens Landing Page Report Get a Unique Contact Adds Landing Page Report Get a Unique Contact SMS Opt Ins Landing Page Report Get a Unique Contact Updates Landing Page Report

Get an SMS Campaign Summary Report

Technology Partner Overview Signup for a Technology Partner Developer Account Technology Partner Registration Technology Partner Authentication Configuring Identity Provider (IdP) Initiated SSO Create a new Partner Client Account Get all Partner Client Accounts Unsubscribe Contacts Under Partner Client Accounts Get Billing Plan Details for a Client Account Update the Billing Plan for a Client Account Cancel the Billing Plan for a Client Account Send API Requests on Behalf of Managed Client Accounts

Partner Webhooks Get a Partner Webhook Get all Partner Webhooks Subscribe (PUT) to a Partner Webhook Unsubscribe (Delete) a Partner Webhook Test (POST) Webhook Subscriptions Confirming Webhook Authenticity

Tagged: yaml

2 pages tagged “yaml”

Using the Developer Portal
V3 API Schema

Email Us Developer Forums Terms of Service Acceptable Use Policy Anti-Spam Privacy Center Vulnerability Disclosure2026 Constant Contact, Inc.