Jump to Content
API Reference
Log In
API Reference
Log In
API Reference
Get Schema
Search
JUMP TO
ACT-ON API
API Overview
Request a Developer Account
Account
Userspecs Overview
Create new account user
post
Delete account users
post
Get defined email senders
get
Fact
Upload custom events
post
Get upload custom event status
get
Content
Get logo list
get
Add a logo
post
Get a logo
get
Update a logo
put
Delete a logo
delete
Get header list
get
Get a header
get
Update a header
put
Delete a header
delete
Add a header
post
Get footer list
get
Get a footer
get
Delete a footer
delete
Update a footer
put
Add a new footer
post
Get image list
get
Add an image
post
Get an image
get
Update an image
put
Delete an image
delete
Get media list
get
Get media file
get
Update Media File
put
Delete a media object
delete
Add a media file
post
Add a media link
post
Get form list
get
Get classic form URLs
get
Get landing page list
get
Get landing page
get
Delete landing page
delete
Get landing page URLs
get
Get list of programs
get
Reporting
Get message report
get
Get message report drilldown
get
Get message report by time period
get
Get media report
get
Get media message report
get
Get a media view report
get
Get a media timeline report
get
Get form report
get
Get landing page report
get
Email Campaign
Get message list
get
Add new template or draft message
post
Get Campaign
get
Get Campaigns List
get
Send a message
post
Resend a message
put
Update template or draft message
put
Delete a message
delete
Get message HTML contents
get
ETE Request
post
SEO
Get a new SEO report
get
Get SEO keywords
get
Contacts > Contact
Add a contact
post
Upsert a contact record by email
put
Get contact history and score
get
Get contact record
get
Update a contact by record ID
put
Delete a contact
delete
Delete multiple contacts
delete
Get contact record ID based on cookie value
get
Get contact from list based on cookie ID or e-mail
get
Set Multiple Subscriptions by email address
put
Update Subscription by Email
put
Contact > Marketing Lists
UploadSpecs Overview
Mergespecs Overview
Delete records from a list
delete
Get list of Act-On Assets
get
Create a new list
post
Download List
get
Update or merge a list
put
Delete a list
delete
Get list upload status
get
Get rejected records from an upload
get
Contacts > System Lists
Get Subscription Categories
get
Get subscription opt-outs by category
get
Get hard bounce list
get
Get spam complaint list
get
Get Opt Out List
get
Update optout list
put
Remove Opt Outs
put
Oauth
Grant-Type Password
post
Grant-Type Refresh
post
Grant-Type Code
Audience Center Contacts API
Contact Import Management
Import Contacts
post
Get Import Definitions
get
Create an Import Definition
post
Get Import Definition by Id
get
Update an Import Definition
put
Delete Import Definition by Id
delete
Get Import status
get
Contact Management
Get contacts from the Act-On Contacts List
get
Add a single contact to the Act-On Contacts List
post
Get contacts from the Act-On Contacts List specifying the fields to be returned
post
Get contact in the Act-On Contacts List by cookie id
get
Get contacts from the Act-On Contacts List by email address
get
Update contacts in the Act-On Contacts List by email address
put
Delete contact in the Act-On Contacts List by email address
delete
Delete contacts in the Act-On Contacts List by emails
delete
Get contact in the Act-On Contacts List by externalId and object type
get
Update contact in the Act-On Contacts list by externalId & objectType, fallback to email match
put
Delete contact in the Act-On Contacts List by externalId and object type
delete
Get contact in the Act-On Contacts List by id
get
Update contact in the Act-On Contacts List by id
put
Delete contacts in the Act-On Contacts List by ids
delete
Contact Report Management
Get contact history by email address
get
Get all scores for a contact by email address
get
Get all segments that the contact belong by email address
get
Get contact history by externalId and object type
get
Get all scores for a contact by externalId and object type
get
Get all segments that the contact belong by externalId and object type
get
Get contact history by id
get
Get all scores for a contact by id
get
Get all segments that the contact belong by id
get
UCL Schema Management
Get Schema
get
Add Field
post
Update FieldDefinition
put
Delete Field
delete
UCL Segment Management
Get Segments
get
Create a segment
post
Get Segment by Id
get
Update Segment. If it's a Direct Select Segment, only the name can be updated.
put
Delete Segment
delete
Get Contacts from a Segment
get
Add Contacts to a Direct Select Segment
put
Remove Contacts from Direct Select Segment
delete
Remove Contacts from Direct Select Segment by email
delete
Add Contacts to a Direct Select Segment By External id
put
Remove Contacts from Direct Select Segment by external id
delete
Custom Objects Service (Beta)
Custom Objects Query API (Beta)
Query data from a custom object dataset
post
Custom Objects Data API (Beta)
Creates a new dataset for a custom object schema
post
Retrieves the details for a dataset using its ID or name
get
Updates a dataset's name and description
post
Deletes the dataset based on the provided dataset Id
delete
Ingests a JSON stream for a specific dataset or object
post
Ingests a CSV or JSON file for a specific dataset or object
post
Validates a file against a schema without ingesting data
post
Retrieves a list of all datasets for a specific schema
get
Retrieve the status for the Job Id
get
Download the report for the provided Job Id
get
Retrieves a list of all datasets for the account
get
Delete records from a dataset based on the provided IDs or ID range
delete
Custom Objects Schema API (Beta)
Returns a Custom Objects schema
get
Updates a Custom Objects schema basic properties
put
Deletes one Custom Objects schema
delete
Updates Custom Objects field properties
put
Adds fields to Custom Objects schemas
post
Deletes fields from Custom Objects schemas
delete
Create a Custom Objects schema
post
Returns all Custom Objects schemas
get
Deletes all Custom Objects schemas
delete
Logging Configuration API (Beta)
Get system-wide logging configuration
get
Update system-wide logging configuration
put
Get account-specific logging configuration
get
Update or create account-specific logging configuration
put
Delete account-specific logging configuration
delete
Invalidate all configuration caches
post
OAuth - Temp
Getting Started With Your API
Powered by
Get Schema
get
https://api.actonsoftware.com/ucl/v2/
{accountId}
/schema/
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
