Upload Object Schema (/v2/crm/entity-schema)

Enables you to add, edit or remove fields to Gong CRM entities, so that you can display additional CRM data in Gong. Fields that are not included in the Gong CRM objects, and are uploaded without updating your schema, are not displayed in Gong.

Update your schema when:

• You create a new integration
• There are changes to the schema of any object type. You can also send a schema update request before any request to the /v2/crm/entities API.

When updating your schema:

• Add or change field: include all fields you want in the schema, including those sent previously. Example:

  Date	Action	Result
  3/4/2023	Send account schema with fieldA	fieldA added to the account
  6/4/23	Send account schema with fieldA and fieldB	fieldA still included in account schema. fieldB added to the account
  8/4/23	Send account schema with fieldC but without fieldA and fieldB	Receive an error that you must include all fields in the schema
  15/4/23	Send account schema with fieldB, fieldC, and isDeleted for fieldA	fieldA and all it's data are deleted. fieldB and fieldC remain in the schema

• Changing a field: if you change the field type, a new field is created and the data associated with the original field is deleted. Other changes, such as the label do not result in data being deleted.
• Deleting a field: to delete a field and it's associated data, send the field with isDeleted = true

When accessed using a bearer token, this endpoint requires the 'api:crm:schema' scope.

Supported field types

This table describes the field types that can be added to your schema

* In the integration send a number value, and specify the correct currency symbol in the Gong UI. Currently Gong does not support multiple currencies per company.

Example

Request

POST https://api.gong.io/v2/crm/entity-schema?integrationId=6286478263646&objectType=ACCOUNT

[{"uniqueName": "orderId", "label": "ID", "type": "ID", "lastModified": "2020-11-11T08:11:34+01:00"},

{"uniqueName": "parentAccount", "label": "Main Account", "type": "REFERENCE", "referenceTo": "ACCOUNT", "lastModified": "2020-11-11T08:11:34+01:00"},

{"uniqueName": "category", "label": "Category", "type": "PICKLIST", "orderedValueList": ["Analyst", "Competitor", "Customer", "Integrator", "Investor", "Partner", "Other"], "lastModified": "2020-11-11T08:11:34+01:00"},

// remove custom field

{"uniqueName": "industry", "isDeleted": true, "label": "Industry", "type": "PICKLIST", "lastModified": "2020-11-21T08:11:34+01:00"}]