How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Act-On Custom Objects Service

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 operations 17 paths 12 schemas 5 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.

Custom Data Schema API 9

Custom Data Schema API

GET
/v1/{accountId}/schema/{objectId}
Returns a Custom Data schema
getSchema 2 params → 200400401404415500
PUT
/v1/{accountId}/schema/{objectId}
Updates a Custom Data schema basic properties
updateSchema 2 params body → 200400401404500
DELETE
/v1/{accountId}/schema/{objectId}
Deletes one Custom Data schema
deleteSchema 3 params → 200400401404415500
PUT
/v1/{accountId}/schema/{objectId}/field
Updates Custom Data schema field properties
updateFields 2 params body → 200400401404500
POST
/v1/{accountId}/schema/{objectId}/field
Adds fields to Custom Data schemas
addFields 2 params body → 200400401404415500
DELETE
/v1/{accountId}/schema/{objectId}/field
Deletes fields from Custom Data schemas
deleteFields 2 params body → 200400401404415500
POST
/v1/{accountId}/schema
Create a Custom Data schema
createSchema 2 params body → 200400401403409415500
GET
/v1/{accountId}/schema/all
Returns all Custom Data schemas
getAllSchemas 1 param → 200400401415500
DELETE
/v1/{accountId}/schema/all
Deletes all Custom Data schemas
deleteAllSchemas 2 params → 200400401415500
Custom Data Query API 3

Custom Data Query API

POST
/v1/{accountId}/query/{objectId}/{datasetId}/joinWithOther
Query data from a Custom Data dataset
queryData 3 params body → 200400401403404500
POST
/v1/{accountId}/query/{objectId}/{datasetId}/joinWithOtherInternal
Internal query data from a custom object dataset
internalQueryData 3 params body → 200400401403404500
POST
/v1/{accountId}/query/joinWithOtherPreflight
Cache hydration preflight for query performance
cacheHydrationPreflight 1 param → 200400401403500
Custom Data Dataset API 12

Custom Data Dataset API

POST
/v1/{accountId}/data/{objectId}
Creates a new dataset for a Custom Data schema
createDataset 2 params body → 200400401403500
GET
/v1/{accountId}/data/{objectId}/{identifier}
Retrieves the details for a dataset using its ID or name
describeDataset 3 params → 200400401403404500
POST
/v1/{accountId}/data/{objectId}/{identifier}
Updates a dataset's name and description
updateDataset 3 params body → 200400401403404409500
DELETE
/v1/{accountId}/data/{objectId}/{identifier}
Deletes the dataset based on the provided dataset Id
deleteDataset 3 params → 200400401403500
POST
/v1/{accountId}/data/{objectId}/{identifier}/json
Ingests a JSON stream for a specific dataset or object
ingestJsonStream 7 params → 200400401403409415500
POST
/v1/{accountId}/data/{objectId}/{identifier}/file
Ingests a CSV or JSON file for a specific dataset or object
ingestFile 8 params body → 200400401403409415500
POST
/v1/{accountId}/data/{objectId}/validate
Validates a file against a schema without ingesting data
validateFile 2 params body → 200400401403409415500
GET
/v1/{accountId}/data/{objectId}/all
Retrieves a list of all datasets for a specific schema
listDatasetsBySchemaId 2 params → 200400401403500
GET
/v1/{accountId}/data/status/{jobId}
Retrieve the status for the Job Id
getJobStatus 2 params → 200400401403415500
GET
/v1/{accountId}/data/report/{jobId}
Download the report for the provided Job Id
getJobReport 2 params → 200400401403415500
GET
/v1/{accountId}/data/all
Retrieves a list of all datasets for the account
listAllDatasets 1 param → 200400401403500
DELETE
/v1/{accountId}/data/{objectId}/{identifier}/ids
Delete records from a dataset based on the provided IDs or ID range
deleteIds 3 params body → 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 properties 1 required
CreateDatasetRequestDTO
object
The dataset creation details
3 properties
UpdateDatasetRequestDTO
object
The dataset update details
3 properties
ValidationRequestDTO
object
The validation request details
2 properties 1 required
DeleteRecordsRequestDTO
object
The record deletion details
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

act-on-custom-objects-service-openapi.yml Raw ↑
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.