Custom Object Classes
The Custom Object Class object is used to represent a Custom Object Schema in the remote system.
The CustomObjectClass object
Properties
nameString
Optional
descriptionString
Optional
labelsObject
Required
fieldsRemoteFieldClassForCustomObjectClass[]
Required
association_typesArray
Optional
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
modified_atString
Required
The CustomObjectClass object
JSON
{
  "name": "order",
  "description": "Order object",
  "labels": {
    "singular": "Order",
    "plural": "Orders"
  },
  "fields": [
    {
      "display_name": "Order ID",
      "remote_key_name": "order_id",
      "description": "The unique ID for the order.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "string",
      "field_format": null,
      "field_choices": [],
      "item_schema": null
    },
    {
      "display_name": "Order Quantity",
      "remote_key_name": "order_quantity",
      "description": "The number of items ordered.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "number",
      "field_format": null,
      "field_choices": [],
      "item_schema": null
    },
    {
      "display_name": "Customer Type",
      "remote_key_name": "customer_type",
      "description": "The type of customer.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "string",
      "field_format": null,
      "field_choices": [
        "New",
        "Returning"
      ],
      "item_schema": null
    }
  ],
  "association_types": [
    {}
  ],
  "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
  "remote_id": "9579977",
  "modified_at": "2021-10-16T00:00:00Z"
}

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

GET
/custom-object-classes

Returns a list of CustomObjectClass objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "name": "order",
      "description": "Order object",
      "labels": {
        "singular": "Order",
        "plural": "Orders"
      },
      "fields": [
        {
          "display_name": "Order ID",
          "remote_key_name": "order_id",
          "description": "The unique ID for the order.",
          "is_required": true,
          "is_nested_list": false,
          "field_type": "string",
          "field_format": null,
          "field_choices": [],
          "item_schema": null
        },
        {
          "display_name": "Order Quantity",
          "remote_key_name": "order_quantity",
          "description": "The number of items ordered.",
          "is_required": true,
          "is_nested_list": false,
          "field_type": "number",
          "field_format": null,
          "field_choices": [],
          "item_schema": null
        },
        {
          "display_name": "Customer Type",
          "remote_key_name": "customer_type",
          "description": "The type of customer.",
          "is_required": true,
          "is_nested_list": false,
          "field_type": "string",
          "field_format": null,
          "field_choices": [
            "New",
            "Returning"
          ],
          "item_schema": null
        }
      ],
      "association_types": [
        {}
      ],
      "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
      "remote_id": "9579977",
      "modified_at": "2021-10-16T00:00:00Z"
    }
  ]
}

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

GET
/custom-object-classes/{id}

Returns a CustomObjectClass object with the given id.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{
  "name": "order",
  "description": "Order object",
  "labels": {
    "singular": "Order",
    "plural": "Orders"
  },
  "fields": [
    {
      "display_name": "Order ID",
      "remote_key_name": "order_id",
      "description": "The unique ID for the order.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "string",
      "field_format": null,
      "field_choices": [],
      "item_schema": null
    },
    {
      "display_name": "Order Quantity",
      "remote_key_name": "order_quantity",
      "description": "The number of items ordered.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "number",
      "field_format": null,
      "field_choices": [],
      "item_schema": null
    },
    {
      "display_name": "Customer Type",
      "remote_key_name": "customer_type",
      "description": "The type of customer.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "string",
      "field_format": null,
      "field_choices": [
        "New",
        "Returning"
      ],
      "item_schema": null
    }
  ],
  "association_types": [
    {}
  ],
  "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
  "remote_id": "9579977",
  "modified_at": "2021-10-16T00:00:00Z"
}

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

PUT
/custom-object-classes/generator/{generator_id}

Updates a CustomObjectClass object with the given id.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
generator_idString
Required
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Response
JSON
{
  "name": "order",
  "description": "Order object",
  "labels": {
    "singular": "Order",
    "plural": "Orders"
  },
  "fields": [
    {
      "display_name": "Order ID",
      "remote_key_name": "order_id",
      "description": "The unique ID for the order.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "string",
      "field_format": null,
      "field_choices": [],
      "item_schema": null
    },
    {
      "display_name": "Order Quantity",
      "remote_key_name": "order_quantity",
      "description": "The number of items ordered.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "number",
      "field_format": null,
      "field_choices": [],
      "item_schema": null
    },
    {
      "display_name": "Customer Type",
      "remote_key_name": "customer_type",
      "description": "The type of customer.",
      "is_required": true,
      "is_nested_list": false,
      "field_type": "string",
      "field_format": null,
      "field_choices": [
        "New",
        "Returning"
      ],
      "item_schema": null
    }
  ],
  "association_types": [
    {}
  ],
  "id": "ff1ff4cb-a66b-47dc-8e2a-50388049e602",
  "remote_id": "9579977",
  "modified_at": "2021-10-16T00:00:00Z"
}

This endpoint is currently supported for Salesforce, Hubspot, and Zendesk Sell. More integrations coming soon!

Previous
Users
Next Up
Custom Objects