API reference
Custom Objects API
Records of your own types, such as subscriptions or appointments, linked to profiles.
Endpoints
- POSTSend records to a data source/api/data-source-record-bulk-create-jobs
- POSTSend one record to a data source/api/data-source-record-create-jobs
- GETList data sources/api/data-sources
- POSTCreate a data source/api/data-sources
- POSTDelete object records/api/object-record-bulk-delete-jobs
- POSTCreate an object schema/api/object-schemas
- GETList object types/api/object-types
- POSTCreate an object type/api/object-types
- GETGet a data source/api/data-sources/{id}
- DELDelete a data source/api/data-sources/{id}
- GETGet an object record/api/object-records/{id}
- GETGet an object schema/api/object-schemas/{id}
- PATCHUpdate or publish an object schema/api/object-schemas/{id}
- GETGet an object type/api/object-types/{id}
- DELDelete an object type/api/object-types/{id}
- GETGet a source mapping/api/source-mappings/{id}
- PATCHUpdate a source mapping/api/source-mappings/{id}
- GETGet an object schema's source mapping/api/object-schemas/{id}/source-mapping
- GETGet an object type's current schema/api/object-types/{id}/current-schema
- GETGet an object type's draft schema/api/object-types/{id}/draft-schema
- GETList an object type's ingestion failures/api/object-types/{id}/object-ingestion-logs
- GETList an object type's records/api/object-types/{id}/object-records
- GETList an object type's schema versions/api/object-types/{id}/schema-versions
- GETList an object schema's relationships to other object schemas/api/object-schemas/{id}/relationships/object-schemas
- POSTAdd relationships from an object schema to other object schemas/api/object-schemas/{id}/relationships/object-schemas
- PATCHRename or describe a relationship from an object schema to other object schemas/api/object-schemas/{id}/relationships/object-schemas
- DELRemove relationships from an object schema to other object schemas/api/object-schemas/{id}/relationships/object-schemas
- GETList an object schema's relationships to profiles/api/object-schemas/{id}/relationships/profile-object-schemas
- POSTAdd relationships from an object schema to profiles/api/object-schemas/{id}/relationships/profile-object-schemas
- PATCHRename or describe a relationship from an object schema to profiles/api/object-schemas/{id}/relationships/profile-object-schemas
- DELRemove relationships from an object schema to profiles/api/object-schemas/{id}/relationships/profile-object-schemas
- GETGet the id of an object schema's source mapping/api/object-schemas/{id}/relationships/source-mapping
- GETGet the id of an object type's current schema/api/object-types/{id}/relationships/current-schema
- GETGet the id of an object type's draft schema/api/object-types/{id}/relationships/draft-schema
- GETList the ids of an object type's ingestion failures/api/object-types/{id}/relationships/object-ingestion-logs
- GETList the ids of an object type's records/api/object-types/{id}/relationships/object-records
- GETList the object types an object type relates to/api/object-types/{id}/relationships/object-types
- GETList the profile relationships of an object type/api/object-types/{id}/relationships/profile-object-types
- GETList the ids of an object type's schema versions/api/object-types/{id}/relationships/schema-versions
Access
A private key with these scopes reaches every endpoint here. Each endpoint page lists the scopes it needs.
custom-objects:readcustom-objects:writeCoverage
39 of the 39 operations in this area of Klaviyo's API are built here.
Complete
Every operation in this area of Klaviyo's API is built.