Create an object schema
https://email.growthdept.ai/api/object-schemasWith relationships.object-type, a new draft version of that type (replacing an unpublished draft); without it, a new object type.
The request body can be up to 5 MB.
Rate limits
Scopes
custom-objects:write
Operation id
create_object_schema The same operation as in Klaviyo's API. OpenAPI document
Query parameters
Pick values to add them to the request:
Body
Send application/vnd.api+json or application/json.
object
dataobjectrequired
data: 5 fields
typestringrequired
object-schemaidstring
attributesobjectrequired
attributes: 6 fields
titlestringrequired
descriptionstringcan be null
propertiesarray of objectsrequired
properties: 4 fields
idintegerrequired
namestringrequired
typestringrequired
booleanfloatintlist_strstringtimestampdescriptionstringcan be null
statusstring
requiredarray of strings
source-mappingobject
source-mapping: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
source-mappingattributesobjectrequired
attributes: 2 fields
property_mappingsarray of objects
relationship_mappingsarray of objects
relationship_mappings: 3 fields
relationship_idstringrequired
typestringrequired
simplesourceobjectrequired
relationshipsobject
relationships: 1 field
object-typeobject
object-type: 1 field
dataobjectrequired
data: 2 fields
typestringrequired
object-typeidstringrequired
metaobject
Edit the example. The code samples use what you type here.
Headers
stringrequireddefault 2026-10-15
API revision, YYYY-MM-DD. This server implements 2026-10-15.
Responses
201Success
Response body
object
dataobjectrequired
data: 5 fields
typestringrequired
object-schemaidstringrequired
attributesobjectrequired
attributes: 7 fields
titlestringrequired
descriptionstringrequired
statusstringrequired
activedraftpublishingundefinedpropertiesarray of objectsrequired
properties: 4 fields
idintegerrequired
namestringrequired
typestringrequired
booleanfloatintlist_strstringtimestampdescriptionstringcan be null
requiredarray of stringsrequired
published_atstring (date-time)can be null
visibilitystringrequired
privateshared
relationshipsobject
relationships: 3 fields
source-mappingobject
source-mapping: 2 fields
dataobject
data: 2 fields
typestringrequired
source-mappingidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
object-schemasobject
object-schemas: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
object-schemaidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
profile-object-schemasobject
profile-object-schemas: 2 fields
dataarray of objects
data: 2 fields
typestringrequired
profile-object-schemaidstringrequired
linksobject
links: 2 fields
selfstring (uri)required
relatedstring (uri)required
linksobjectrequired
links: 1 field
selfstring (uri)required
linksobject
links: 1 field
selfstring (uri)required
metaobject
4XXClient error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject
See status codes for each code.
5XXServer error
Response body
object
errorsarray of objectsrequired
errors: 8 fields
idstringrequired
statusintegerrequired
codestringrequired
titlestringrequired
detailstringrequired
sourceobject
source: 2 fields
pointerstring
parameterstring
linksobject
metaobject