Create a Custom Object Schema

Defines a new custom object schema with fields and metadata in your CRM.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Supported apps for Create Schema

Close CRM (close-crm)

Supported Request Fields:

  • schemaId
  • title - Required
  • titlePluralized - Required
  • description

Supported Response Fields:

  • schemaId
HubSpot (hubspot)

Supported Request Fields:

  • schemaId
  • title
  • titlePluralized
  • description
  • fields
  • fields.fieldKey
  • fields.title
  • fields.type

Additional Metadata:

  • metadata.requiredProperties
  • metadata.associatedObjects
  • metadata.primaryDisplayProperty

Supported Response Fields:

  • schemaId
Zendesk CRM (zendesk-crm)

Supported Request Fields:

  • schemaId
  • title
  • titlePluralized
  • description
  • fields
  • fields.fieldKey
  • fields.title
  • fields.type

Supported Response Fields:

  • schemaId
Zoho CRM (zoho-crm)

Supported Request Fields:

  • schemaId
  • title
  • titlePluralized
  • description
  • fields
  • fields.fieldKey
  • fields.title
  • fields.type

Additional Metadata:

  • metadata.profiles

Supported Response Fields:

  • schemaId
Attio (attio)

Supported Request Fields:

  • schemaId - Required - expects A unique, human-readable slug to access the object through URLs and API calls. Should be formatted in snake case
  • title - Required
  • titlePluralized - Required
  • fields - not honored, give [] to avoid required field error, use separate api to add field to a schema

Supported Response Fields:

  • schemaId
Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

  • schemaId - Not Honored can be a "" to avoid required field error.
  • title - Required
  • titlePluralized - Required
  • field - not honored, give [] to avoid required field error, use separate api to add field to a schema
  • description

Additional Metadata:

  • metadata.Attributes - Required - a json array with at least one object with IsPrimaryName set to true. Example : {"Attributes":[{"@odata.type":"Microsoft.Dynamics.CRM.StringAttributeMetadata","SchemaName":"new_Name","MaxLength":100,"IsPrimaryName":true,"DisplayName":{"@odata.type":"Microsoft.Dynamics.CRM.Label","LocalizedLabels":[{"@odata.type":"Microsoft.Dynamics.CRM.LocalizedLabel","Label":"Name","LanguageCode":1033}]}}]}

Supported Response Fields:

  • schemaId
Twenty (twenty)

Supported Request Fields:

  • schemaId - Not Honored can be a "" to avoid required field error.
  • title - Required
  • titlePluralized - Required
  • field - not honored, give [] to avoid required field error, use separate api to add field to a schema
  • description
  • metadata

Supported Response Fields:

  • schemaId
Body Params
string
string
string
string
fields
array of objects
fields
json
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json