> ## Documentation Index
> Fetch the complete documentation index at: https://help.gong.io/llms.txt
> Use this file to discover all available pages before exploring further.
# 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
| Field type | Format in JSON | Possible values |
|---|
| BOOLEAN | boolean | true, false |
| DATE | string (ISO-8601 date without time) | "2020-05-31" |
| DATETIME | string (ISO-8601 datetime without milliseconds) | "2020-12-17T07:37:21+02:00" "2020-12-17T05:37:21Z" |
| PICKLIST | string - one of the values in an orderedValueList | "Analyst" |
| NUMBER | number | 45.66, 8453 |
| PERCENT | number (between 0 to 100) | 67.3 |
| CURRENCY* | number | 34.68 |
| PHONENUMBER | string | "+14055766687" |
| EMAILADDRESS | string | "john.doe@anywhere.com" |
| REFERENCE | string - the id of another object | "48b009drax" |
| ID | string - the id of the object | "843hf8484jr84htg" |
| STRING | string | "whatever you want" |
| URL | string | "https://crm.com/account/6d4r578f" |
* 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"}]
## OpenAPI
````json POST /v2/crm/entity-schema
{
"openapi": "3.0.1",
"info": {
"title": "Gong API",
"version": "V2"
},
"servers": [
{
"url": "http://127.0.0.1:8090",
"description": "Generated server url"
}
],
"tags": [
{
"name": "Calls",
"description": "Gong’s “Calls” API endpoints allow you to:
\n\n- \nRequest calls details from Gong\n
\n- \nUpload new calls to Gong\n
\n- \nUpdate Gong Calls with new media\n
\n
\nThe requested calls may contain the following call details:
\n\n- \nMeta Data (Basic details such as call date, title, call URL, etc)\n
\n- \nParties (A list of the call's participants)\n
\n- \nMedia (The media urls of the call)\n
\n- \nContent (Analysis of the interaction content)\n
\n- \nAction Items (A list of action items)\n
\n- \nStructure (A list of the agenda of each part of the call)\n
\n- \nTopics (A list of topics and their durations)\n
\n- \nTrackers (A list of trackers found in the call. Trackers are collections of phrases defined in Gong for this company)\n
\n- \nPhrases (A list of occurrence counters for each specific phrase within the tracker (e.g., Amazon, Walmart))\n
\n- \nContext (A list of links to external systems such as CRM, Dialer, Case Management, etc)\n
\n
\n \n- \nInteraction (Metrics collected around the interaction during the call)\n
\n- \nInteraction Stats (A list of interaction statistics. Applicable values: 'Talk Ratio', 'Longest Monologue', \n'Longest Customer Story', 'Interactivity', 'Patience')\n
\n- \nQuestions (Question counts of the call)\n
\n- \nSpeakers (A list of the talk duration per speaker)\n
\n- \nVideo (A list of video statistics about what's presented and for how long)\n
\n
\n \n- \nCollaboration (Collaboration information added to the call)\n
\n- \nPublic Comments (A list of public comments)\n
\n
\n \n- \nContext (A list of links to external systems such as CRM, Dialer, Case Management, etc)\n
\n- \nObjects (List of objects within the external system)\n
\n- \nFields (Object fields)\n
\n
\n \n
\n"
},
{
"name": "Users",
"description": "Gong’s “Users” API endpoints allow you to:
\n\n- \nRequest a list of all the company's users with details\n
\n- \nRequest a specific user’s history from Gong\n
\n
\nThe requested users may contain the following details:
\n\n- \nIf the Gong user is active or not.\n
\n- \nCreation time of the Gong user.\n
\n- \nThe email address of the Gong user.\n
\n- \nList of email address aliases of the Gong user.\n
\n- \nThe extension number of the Gong user.\n
\n- \nThe first name of the Gong user.\n
\n- \nThe last name of the Gong user.\n
\n- \nGong's unique numeric identifier for the user.\n
\n- \nThe manager ID of the Gong user.\n
\n- \nThe Gong recording consent meeting link.\n
\n- \nThe list of personal meeting URLs of the Gong user.\n
\n- \nThe phone number of the Gong user.\n
\n- \nThe job title of the Gong user.\n
\n- \nThe user's settings.\n
\n- \nIf the team member is set to import emails by Gong.\n
\n- \nIf the team member is set to prevent import of emails by Gong.\n
\n- \nIf the invitation of this user to a web conference will prevent its recording (even if other users invited are set to record).\n
\n- \nIf the team member is set to import telephony calls by Gong.\n
\n- \nIf the team member is set to be recorded by Gong.\n
\n
\n \n- \nThe User's settings history.\n
\n- \nThe user capability that was changed.\n
\n- \nThe date and time the action was set.\n
\n- \nThe new value that was set.\n
\n
\n \n
\n"
},
{
"name": "Stats",
"description": "Gong’s “Stats” API endpoints allow you to:
\n\n- \nRequest user activity\n
\n- \nRequest scorecards activity\n
\n- \nRequest interaction stats on calls that have Whisper turned on\n
\n
\nThe requested user activity may contain the following details:
\n\n- \nCalls Hosted: The number of recorded calls this user hosted.\n
\n- \nCall Participated: The number of calls in which this user is a participant (not host).\n
\n- \nCalls Reviewed: The number of calls in which someone pressed the \"Mark as reviewed\".\n
\n- \nCalls Listened: The number of other users' calls the user listened to.\n
\n- \nCall Shared Outside: The number of calls the user shared with others outside the company.\n
\n- \nCall Shared Inside: The number of calls the user shared with others inside the company.\n
\n- \nOwn Calls Listened: The number of the user's own calls the user listened to.\n
\n- \nComment Given: The number of calls in which a user gave at least one comment.\n
\n- \nComment Received: The number of calls in which a user received at least one comment on the users calls.\n
\n- \nFeedback Given: The number of recorded calls the user gave feedback on.\n
\n- \nFeedback Received: The number of recorded calls the user received feedback on.\n
\n- \nFeedback Requested: The number of recorded calls the user requested feedback on.\n
\n- \nScorecard Filled: The number of calls in which someone filled a scorecard on the user's calls.\n
\n- \nScorecards Completed: The number of scorecards the user completed.\n
\n- \nScorecards Answers: The answers in the answered scorecard.\n
\n- \nWhisper: Person Interaction Stats (List of user interaction stats. Applicable values: 'Talk Ratio',\n 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Question Rate', 'Patience').\n
\n
\n"
},
{
"name": "Settings",
"description": "Gong’s “Settings” API endpoints allow you to:
\n\n- \nRequest all the scorecards within the Gong system.\n
\n- \nRequest all the workspaces including their details.\n
\n
\n"
},
{
"name": "Data Privacy",
"description": "Gong’s “Data Privacy” API endpoints allow you to:
\n\n- \nRequest all references to an email address.\n
\n- \nRequest all references to a phone number.\n
\n- \nDelete the email address, and all associated elements.\n
\n- \nDelete the phone number, and all associated elements.\n
\n
\n"
},
{
"name": "Library",
"description": "Gong’s “Library” API endpoints allow you to:
\n\n- \nRequest all the calls in a specific folder.\n
\n- \nRequest all the Library folders. We do not allow retrieval of either private or archived folders.\n
\n
\n"
},
{
"name": "CRM",
"description": "If you are using the deprecated endpoints, download the PDF file.
What does the CRM API do?
This API enables integration with CRMs that are not natively integrated with Gong, so that Gong can provide you with its full capabilities based on your CRM data. This includes:
- Pipeline review and forecast
- Narrow down conversations (calls and emails) by customer data for coaching and analytics
- Track initiatives and adoption based on accounts and opportunities
By uploading your CRM data to Gong, your Gong users will be able to see their CRM deals in the Gong Deals page, view deal boards to follow up on deal progress, get warnings for deals that are at risk, and see whether their team will reach its quota. The CRM data is also displayed in conversations and calls, so that your Gong users can see account and contact data such as the name and job title of the contact in the call. Account data is displayed in the Accounts page, together with the history of all communication and contact with the company.
Note: Gong provides native integrations with Salesforce, HubSpot and Microsoft Dynamics 365.
API Protocol
The API protocol is based on REST guidelines. Check here what's your base URL for all API calls.\nThe payload is either a JSON object or, for API calls that upload lists of objects, line delimited JSON (see: JSON streaming). JSON objects should be UTF-8 encoded.
Dates and timestamps in JSON objects should be in ISO-8601 format without milliseconds (e.g. '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC).
What data can I upload?
To see your CRM data in Gong, upload the following entities:
- Business User: The CRM user, such as a seller or manager.
- Account: The customer details in the CRM
- Contact: A specific contact in the CRM that is associated with a customer
- Deal: A deal or opportunity, or a contract of a specific account in the CRM
- Lead: A potential customers who are not associated with an account
- Stage: The list of stages the deal can be in, in your CRM
Uploading CRM data to Gong
This diagram shows how to set up your system in order to upload CRM data to Gong. This is relevant for each scenario of uploading data, initial, incremental and uploading historical data.
![\"\"](\"/r/img/permanent/crm_api_flow.png\")
Registering your Integration
Register your integration to get an integrationId used to identify your company's integration with Gong. This is a one time action that does not need to be repeated unless you delete your integration.
Use PUT v2/crm/integrations to register your integration. The integration Id is returned in the response. Include the integration Id each time you upload your CRM data.
Uploading additional data for CRM entities
Each CRM entity has a set of standard fields. In addition, you may want to upload additional fields.
Use the POST /v2/crm/entity-schema to adjust the schema according to your needs. Once you have uploaded your schema to Gong, you can upload your entities with the additional fields.
Uploading your CRM data to Gong
This section explains how you can use the CRM API to upload your data to Gong:
First-time upload
Create a database dump of the data you want to upload to Gong based on your CRM schema and data. When uploading your data for the first time you should include all of the CRM records that should appear in Gong.
Incremental upload
Send regular incremental data updates to Gong. You can update your data as often as you like, we recommend updating between every 1-5 minutes.
You should only send new records or records that have changed since the previous upload of data. New records are added to Gong and existing records are updated or deleted, whichever is relevant. Entities are identified by the objectId. Ensure that this ID remains the same each time it is updated.
When updating data, the modificationDate parameter is mandatory. This enables us to maintain accurate historical data. If your CRM does not store the modification date, send the date the API call is made.
Uploading data change history
Gong incorporates historical change data in different areas of Gong in order to provide a more accurate picture of the status of different entities at that time. For example, showing the correct stage of a deal at the time a call was made.
If your CRM stores record history, you are encouraged to load historical change data as part of the integration. You can do this at any time, but we recommend doing this after the initial upload as follows:
- Generate the JSON files with the relevant data. Ensure that the modifiedDate is set to the date the entity was updated.
- Upload the entities with their historical data using the
POST /v2/crm/entities?objectType=ACCOUNT|CONTACT|DEAL|LEAD endpoint.
Gong Data Model
This diagram shows the connection between the different objects in the CRM API:
![\"\"](\"/r/img/permanent/crm_api_model.png\")
The following relationship between entities must exist:
- A contact must be linked to a single account.
- A deal is linked to a single account.
- A deal has an owner who is a user in Gong.
- A converted lead is expected to be converted into an account and/or a deal and/or a contact.
What if my CRM doesn't match the Gong data model?
It is possible that your CRM entity model won't match the Gong CRM entity model. Your CRM may store your data in different entities, or you may not have an entity that represents one of the Gong CRM entities.
In order to upload your CRM data and associate it with calls and conversations, you need to identify the objects in your CRM which match the Gong CRM entities.
The account is a mandatory entity which must be uploaded in order to integrate Gong with your CRM. To upload account data, identify your CRM entities that contain data about your customers or companies that you do business with. These customers are not actual people within the org, rather they represent the org itself.
To upload contact details, identify your CRM entities that hold data about employees in the company that your reps are in touch with. A contact represents a person where communication has advanced beyond the prospect stage. Your reps will have multiple conversations and interactions with the contact.
The deal represents the selling process to the customer (account).
The lead is a prospect or potential contact, who is not yet associated with an account. If your CRM has an entity which represents people who you contact in the very early stages, and who is later converted to another entity which represents the people you are doing business with (the contact), upload this data as a lead entity.
When will my CRM data be displayed in Gong?
In addition to the time it takes for data to upload to Gong, the data is first uploaded as raw data and is not automatically available in Gong.
"
},
{
"name": "Auditing",
"description": "Gong’s “Auditing” API endpoints allow you to request the following log types from Gong:
\n\n- \nAccess Log - This log is preserved for 14 days only\n
\n- \nUser Activity Log - The data is available since March 2021\n
\n- \nUser Call Play Log - All data is available since inception\n
\n- \nExternally Shared Call Access Log - All data is available since inception\n
\n- \nExternally Shared Call Play Log - All data is available since inception\n
\n
\n"
},
{
"name": "Meetings (in Beta Phase)",
"description": "Gong’s “Consent Meeting” API endpoints allow you to:
\n\n- \nRequest creating a Gong Consent meeting link\n
\n- \nUpdate a Consent Meeting’s details\n
\n- \nDelete a Consent Meeting\n
\n- \nList all Licensed Users in the Gong instance and their Consent Page status\n
\n
\nThe requested calls may contain the following meeting details:
\n\n- \nMeeting Scheduled Start Time\n
\n- \nMeeting Scheduled End Time\n
\n- \nOrganizer\n
\n- \nMeeting Title\n
\n- \nInvitees\n
\n- \nExternal Meeting Id - The ID as it is formed on an external system\n
\n
\n"
},
{
"name": "Permissions",
"description": "Gong’s \"Permission\" API endpoints allow you to:
\n\n- \nList all permission profiles in a given workspace\n
\n- \nCreate permission profile\n
\n- \nGet a permission profile\n
\n- \nUpdate permission profile\n
\n- \nList all users controlled by a permission profile\n
\n- \nAllow users individual access to calls\n
\n- \nRemove user's individual access to calls\n
\n- \nRetrieve users that have individual access to calls\n
\n
\n"
},
{
"name": "Engage Flows",
"description": "Gong’s “Flows” API endpoints allow you to:
\n\n- \nView a list of relevant Gong Engage flows to choose from and the current flow assignment status\n
\n- \nAdd prospects to Gong Engage flows\n
\n
\n"
},
{
"name": "Digital Interactions",
"description": "Digital interactions (DIs) are events people make when interacting with (mostly) digital content. It can be described as an action someone did on an object. Anything from viewing a document or a video, to registering/completing a course or someone visiting your website.
The below proposed Digital Interactions API allows mainly tech-partners (and also customers) to capture and track user interactions with various types of digital content. It provides a structured schema for recording a person’s identity, action, content details, and additional contextual information. The API enables seamless integration between tech-partner systems and the Gong platform, providing valuable insights into buyer-seller interactions that sometimes are hidden from a seller’s line-of-sight.
For simplicity & clarity, the API scheme is designed according to a real-world scenario, including the following terminology:For simplicity & clarity, the API scheme is designed according to a real-world scenario, including the following terminology:
- Event: Represents something that happened, described as an action verb + content engaged (e.g., \"signed a contract\").
- Content: Refers to the specific content engaged during the event (e.g., contract). Provides details such as label, title, ID, and URLs.
- Person: Represents the individual responsible for the action. Can be a known person or an anonymous user associated with a company.
- Content Custom Fields: Custom properties for the content. Example: Custom field - \"Version: 2.0\", Custom field - \"Author: Jane Smith\".
- Company: Refers to the organization associated with the person. Example: Company ID - \"7890\", Company name - \"XYZ Corp\".
- Partner: An external collaborating organization that owns a software product involved in the digital interactions captured by the API.
"
},
{
"name": "Integration Settings",
"description": "Configure your integration settings for displaying your company data in iFrames. For example, use this API to configure dynamic links as the iFrame source. This endpoint includes validation mechanisms to ensure the integration is secure.
Mandatory fields are marked with a *.
"
},
{
"name": "Engagement (Legacy – See “Digital Interactions”)",
"description": "\n\nGong’s \"Engagement\" API endpoints allow you to push engagement events into Gong and display them as events in Gong’s activity timeline.
\nThere are currently 3 types of events:
\n\n- \n\"Content Shared\" Event Type - Use this event type to push engagement events into Gong when a Gong user shares content with external participants (for example, a contract was “shared” by the account executive with his prospects)
\n- \n\"Content Viewed\" Event Type - Use this event type to push engagement events into Gong when a content is viewed by an external participant (for example, a contract was “viewed” by the prospect)\n
\n- \n\"Custom Action\" Event Type - Use this event type to push engagement events into Gong when a content is engaged by an external participant (for example, a contract was “signed” by the prospect)
\n
\n"
}
],
"paths": {
"/v2/crm/entity-schema": {
"post": {
"operationId": "uploadCrmSchemaField",
"summary": "Upload Object Schema (/v2/crm/entity-schema)",
"description": "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
| Field type | Format in JSON | Possible values |
|---|
| BOOLEAN | boolean | true, false |
| DATE | string (ISO-8601 date without time) | \"2020-05-31\" |
| DATETIME | string (ISO-8601 datetime without milliseconds) | \"2020-12-17T07:37:21+02:00\" \"2020-12-17T05:37:21Z\" |
| PICKLIST | string - one of the values in an orderedValueList | \"Analyst\" |
| NUMBER | number | 45.66, 8453 |
| PERCENT | number (between 0 to 100) | 67.3 |
| CURRENCY* | number | 34.68 |
| PHONENUMBER | string | \"+14055766687\" |
| EMAILADDRESS | string | \"john.doe@anywhere.com\" |
| REFERENCE | string - the id of another object | \"48b009drax\" |
| ID | string - the id of the object | \"843hf8484jr84htg\" |
| STRING | string | \"whatever you want\" |
| URL | string | \"https://crm.com/account/6d4r578f\" |
* 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\"}]
",
"parameters": [
{
"name": "integrationId",
"in": "query",
"description": "Integration ID generated when creating the integration",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "objectType",
"in": "query",
"description": "The object type to set the schema for (case-sensitive)",
"required": true,
"schema": {
"type": "string",
"enum": [
"ACCOUNT",
"CONTACT",
"DEAL",
"LEAD"
]
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GenericSchemaFieldRequest"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BaseResponse"
}
}
}
},
"201": {
"description": "Successfully uploaded crm schema fields",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaUpdateResponse"
}
}
}
},
"400": {
"description": "Malformed request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"429": {
"description": "API request limit exceeded",
"headers": {
"Retry-After": {
"description": "Number of seconds to wait before making a new request.",
"style": "simple",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Failed to complete the operation due to an unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
},
"tags": [
"CRM"
]
}
}
},
"components": {
"schemas": {
"GenericSchemaFieldRequest": {
"description": "selectedFields",
"type": "object",
"properties": {
"uniqueName": {
"description": "The unique name of the field in the CRM system",
"type": "string",
"example": "accountowner"
},
"label": {
"description": "The label to use in the UI for this field",
"type": "string",
"example": "Account Owner"
},
"type": {
"description": "The field type (case-sensitive). Must be one of the types listed above.",
"type": "string",
"example": "REFERENCE",
"enum": [
"DATE",
"DATETIME",
"NUMBER",
"PERCENT",
"CURRENCY",
"ID",
"URL",
"STRING",
"BOOLEAN",
"PHONENUMBER",
"EMAILADDRESS",
"PICKLIST",
"REFERENCE",
"STRINGARRAY"
]
},
"lastModified": {
"description": "The date and time the schema was last modified.
Valid format: ISO-8601 format without milliseconds e.g., \"2020-12-17T13:45:01Z\"",
"type": "string",
"example": "2020-12-17T13:45:01Z"
},
"isDeleted": {
"description": "When true, deletes the field from the schema and its value is removed from all objects. Use with caution",
"type": "boolean",
"example": false
},
"referenceTo": {
"description": "The object type this field refers to. Required for field of type REFERENCE. Must be one of \"ACCOUNT\", \"CONTACT\", \"DEAL\", \"LEAD\" or \"USER\"",
"type": "string",
"example": "USER"
},
"orderedValueList": {
"description": "The list of values for the field. Required for PICKLIST fields",
"type": "array",
"items": {
"type": "string",
"description": "The list of values for the field. Required for PICKLIST fields",
"example": "[\"Analyst\",\"Competitor\",\"Customer\",\"Integrator\",\"Investor\",\"Partner\",\"Other\"]"
},
"example": [
"Analyst",
"Competitor",
"Customer",
"Integrator",
"Investor",
"Partner",
"Other"
]
}
},
"required": [
"label",
"type",
"uniqueName"
]
},
"BaseResponse": {
"type": "object",
"properties": {
"requestId": {
"description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.",
"type": "string",
"example": "4al018gzaztcr8nbukw"
}
}
},
"SchemaUpdateResponse": {
"type": "object",
"properties": {
"requestId": {
"description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.",
"type": "string",
"example": "4al018gzaztcr8nbukw"
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"requestId": {
"description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.",
"type": "string",
"example": "4al018gzaztcr8nbukw"
},
"errors": {
"description": "Error messages.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"An error has occurred"
]
}
}
}
}
}
}
````