Skip to content

Custom Objects API

Rename or describe a relationship from an object schema to other object schemas

PATCHhttps://email.growthdept.ai/api/object-schemas/{id}/relationships/object-schemas

The request body can be up to 5 MB.

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

custom-objects:write

Operation id

update_object_schema_relationship The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      object-schema
    • idstringrequired

    • metaobject

      meta: 3 fields
      • relationship_idstringrequired

      • namestring

      • descriptionstringcan be null

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.

Revisions guide

Responses

204Success

No body.

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