v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB

Custom Object Schemas

Create custom object schema

post/crm/custom-object-schemas

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

The unique identifier of the custom object schema

namestring nullable

The name of the custom object schema

descriptionstring nullable

The description of the custom object schema

visibleboolean nullable

Whether the custom object schema is visible in the UI

activeboolean nullable

Whether the custom object schema is active

created_bystring nullable

The ID of the user who created the custom object schema

updated_bystring nullable

The ID of the user who last updated the custom object schema

updated_atstring nullable

The timestamp when the custom object schema was last updated

created_atstring nullable

The timestamp when the custom object schema was created

Example request

{
  "id": "cos_12345",
  "name": "project",
  "description": "This schema defines a project custom object",
  "fields": [
    {
      "id": "field_123",
      "name": "project_name",
      "description": "Name of the project",
      "type": "string",
      "required": true,
      "options": [
        {
          "value": "option1",
          "label": "Option 1"
        }
      ],
      "default_value": "New Project"
    }
  ],
  "visible": true,
  "active": true,
  "created_by": "12345",
  "updated_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Custom object schema created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 201,
  "status": "Created",
  "service": "zoho-crm",
  "resource": "custom-object-schemas",
  "operation": "add",
  "data": {
    "id": "cos_12345",
    "name": "project",
    "description": "This schema defines a project custom object",
    "fields": [
      {
        "id": "field_123",
        "name": "project_name",
        "description": "Name of the project",
        "type": "string",
        "required": true,
        "options": [
          {
            "value": "option1",
            "label": "Option 1"
          }
        ],
        "default_value": "New Project"
      }
    ],
    "visible": true,
    "active": true,
    "created_by": "12345",
    "updated_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z",
    "pass_through": [
      {
        "extend_paths": [
          {
            "path": "$.nested.property",
            "value": {
              "TaxClassificationRef": {
                "value": "EUC-99990201-V1-00020000"
              }
            }
          }
        ]
      }
    ]
  }
}