Separately versioned (3.4.3) Custom Data service for defining custom object schemas and fields, creating datasets, validating and ingesting CSV/JSON data, polling ingest jobs, and querying custom data joined against Act-On Contacts with offset or cursor pagination. Act-On states these endpoints are in BETA and available on request only.
This API exposes
24 operations
across 17 paths,
organized into 3 resource areas,
and defines 12 schemas.
It is described by OpenAPI 3.1.0, at version 3.4.3.
Requests are made against a single base URL, https://api.actonsoftware.com/custom-objects.
24 operations17 paths12 schemas5 DELETE7 GET10 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 3.1.0
API Version
3.4.3
Base URL
https://api.actonsoftware.com/custom-objects
Authentication
HTTP Bearer
Resource Areas
3
Authentication & Security 1
Act-On Custom Objects Service declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 24
Across 17 paths, the API surfaces 24 operations — 5 DELETE, 7 GET, 10 POST, 2 PUT. They span 3 resource areas: Custom Data Schema API, Custom Data Query API, Custom Data Dataset API. Each is listed below with its method, path, parameters, and response codes.
Retrieves the details for a dataset using its ID or name
describeDataset3 params→ 200400401403404500
POST
/v1/{accountId}/data/{objectId}/{identifier}
Updates a dataset's name and description
updateDataset3 paramsbody→ 200400401403404409500
DELETE
/v1/{accountId}/data/{objectId}/{identifier}
Deletes the dataset based on the provided dataset Id
deleteDataset3 params→ 200400401403500
POST
/v1/{accountId}/data/{objectId}/{identifier}/json
Ingests a JSON stream for a specific dataset or object
ingestJsonStream7 params→ 200400401403409415500
POST
/v1/{accountId}/data/{objectId}/{identifier}/file
Ingests a CSV or JSON file for a specific dataset or object
ingestFile8 paramsbody→ 200400401403409415500
POST
/v1/{accountId}/data/{objectId}/validate
Validates a file against a schema without ingesting data
validateFile2 paramsbody→ 200400401403409415500
GET
/v1/{accountId}/data/{objectId}/all
Retrieves a list of all datasets for a specific schema
listDatasetsBySchemaId2 params→ 200400401403500
GET
/v1/{accountId}/data/status/{jobId}
Retrieve the status for the Job Id
getJobStatus2 params→ 200400401403415500
GET
/v1/{accountId}/data/report/{jobId}
Download the report for the provided Job Id
getJobReport2 params→ 200400401403415500
GET
/v1/{accountId}/data/all
Retrieves a list of all datasets for the account
listAllDatasets1 param→ 200400401403500
DELETE
/v1/{accountId}/data/{objectId}/{identifier}/ids
Delete records from a dataset based on the provided IDs or ID range
deleteIds3 paramsbody→ 200400401403500
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are DataQueryRequestDTO (13 properties), CreateSchemaRequestDTO (11 properties), RelationshipDefinitionDTO (9 properties), JoinStrategyDTO (8 properties). Each schema is shown below with its type and property counts.
HttpErrorResponse
object
5 properties
CreateSchemaRequestDTO
object
The schema creation details
11 properties
FieldDefinitionDTO
object
A custom object field definition
7 properties
RelationshipDefinitionDTO
object
9 properties
DataQueryRequestDTO
object
The data query specification
13 properties
JoinStrategyDTO
object
Configuration for join operations between Act-On Contacts and Custom Objects
8 properties
PaginationDTO
object
Pagination information for data query requests
4 properties
SortFieldDTO
object
Sort field configuration
2 properties1 required
CreateDatasetRequestDTO
object
The dataset creation details
3 properties
UpdateDatasetRequestDTO
object
The dataset update details
3 properties
ValidationRequestDTO
object
The validation request details
2 properties1 required
DeleteRecordsRequestDTO
object
The record deletion details
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Act-On Custom Objects Service, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.