Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB
Custom Objects

Create custom object

Create custom object

post/crm/custom-objects/{object_id}

Path parameters

object_idstring required

The id of the custom object to query

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

owner_idstring

The unique identifier of the owner of the custom object

namestring nullable

The name of the custom object

updated_bystring

The unique identifier of the user who last updated the custom object

created_bystring

The unique identifier of the user who created the custom object

updated_atstring nullable

The timestamp when the custom object was last updated

created_atstring nullable

The timestamp when the custom object was created

Example request

{
  "id": "co_12345",
  "owner_id": "user_12345",
  "name": "project",
  "fields": [
    {
      "name": "name",
      "value": "string"
    }
  ],
  "updated_by": "user_12345",
  "created_by": "user_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 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": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "custom-objects",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}