> ## 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 CRM objects (/v2/crm/entities)

> <style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}img {  border: 2px solid #D3D5D9;}</style><p>Inserts, updates, or deletes a CRM entity in Gong.</p><p>Gong searches for existing entities with the same ID, to determine whether the entity should be added or updated.</p><p>Ensure you have an authentication key and that you have registered your integration before uploading your CRM data.</p><p>When accessed using a bearer token, this endpoint requires the 'api:crm:upload' scope.</p><h2>Request parameters</h2> <h3>Query String parameters</h3><p>Mandatory parameters are marked with a <font color="red">*</font>.</p><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>integrationId <font color="red">*</font></td>    <td>Integration ID generated when creating the integration</td>    <td>long</td>  </tr>  <tr>    <td>objectType <font color="red">*</font></td>    <td>The object being uploaded. Options are (case-sensitive): <br><ul><li>ACCOUNT</li><li>CONTACT</li><li>DEAL</li><li>LEAD</li><li>BUSINESS_USER</li><li>STAGE</li></ul> </td>    <td>string</td>  </tr>  <tr>    <td>clientRequestId	<font color="red">*</font></td>    <td>A unique identifier sent by you to allow troubleshooting and to prevent repeated attempts to upload the same list of objects.<br>Valid characters: letters, numbers, dashes and underscores.</td>    <td>string</td>  </tr></table><h2>Request Body</h2><ul>  <li>Content-Type should be multipart/form-data</li>  <li>Maximum payload size: 200 megabytes</li></ul><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>dataFile <font color="red">*</font></td>    <td>The LDJSON file with the entity data to upload. A file should only contain objects of one entity type. Records that have multiple updates should be sent in separate files. Each JSON object should be on a separate line. </td>    <td>file</td>  </tr></table><h2>CRM Entities</h2><p>This section details the entities that can be uploaded to Gong </p><h3>Business User</h3><p>The CRM business user represents the Gong user in the CRM and is responsible for the relationship with the account and for creating opportunities and closing deals. Uploading business users enables Gong to associate CRM entities such as accounts and contacts with the relevant user in Gong and with their Gong activity, such as conversations. </p><p>Mandatory parameters are marked with a <font color="red">*</font>.</p><p>To upload your business users to Gong, generate a JSON file with the following fields:</p><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>objectId <font color="red">*</font></td>    <td>The CRM unique ID for the object. <br>Note: objectId can have a maximum of 64 characters and can have the following characters:       <ul>        <li>alpha numeric characters and a "-" </li>        <li>a valid email address</li>      </ul>No other special characters can be used    </td>    <td>string</td>  </tr>  <tr>    <td>modifiedDate <font color="red">*</font></td>    <td>The date and time the object was last modified in the CRM</td>    <td>ISO-8601 datetime format, without milliseconds</td>  </tr>  <tr>    <td>isDeleted</td>    <td>(Default: false) When true, the object is deleted from the database.</td>    <td>boolean</td>  </tr>  <tr>    <td>url</td>    <td>The full URL path to view this object in the CRM</td>    <td>string (Qualified URI)</td>  </tr>  <tr>    <td>emailAddress <font color="red">*</font></td>    <td>The business user's email address. Used to associate the Gong user with the CRM user. Not mandatory when isDeleted = true.</td>    <td>string</td>  </tr></table><h4>Associating the Gong user with the CRM user</h4><p>The CRM user is associated with the Gong user according to the email address. Each CRM deal contains an ownerId field, which is the CRM user ID.</p><p>To update an existing user:</p><ol>  <li>Delete the existing user by uploading the business user entity with isDeleted=true.</li>  <li>In a new request, send the new user details with isDeleted=false, or send a different user with the same email address.</li></ol><h3>Account</h3><p>The account object is an active customer in the CRM. Emails and calls in Gong are associated with this account object.</p><p>Mandatory parameters are marked with a <font color="red">*</font>.</p><p>To upload your CRM accounts to Gong, generate a JSON file with the following fields:</p><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>objectId <font color="red">*</font></td>    <td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters:       <ul>        <li>alpha numeric characters and a "-" </li>        <li>a valid email address</li>      </ul>No other special characters can be used    </td>    <td>string</td>  </tr>  <tr>    <td>modifiedDate <font color="red">*</font></td>    <td>The date and time the object was last modified in the CRM</td>    <td>ISO-8601 datetime format, without milliseconds</td>  </tr>  <tr>    <td>isDeleted</td>    <td>(Default: false) When true, the object is deleted from the database</td>    <td>boolean</td>  </tr>  <tr>    <td>url</td>    <td>A full http URL to browse this object in the CRM</td>    <td>string (Qualified URI)</td>  </tr>  <tr>    <td>name</td>    <td>The account name. <br>Default value: "Account_#"+objectId</td>    <td>string</td>  </tr>  <tr>    <td>domains</td>    <td>The account's domain/s. When an activity can’t be associated with a contact, the participants domain is used to associate the activity to an account via the account domain in this field.</td>    <td>string array</td>  </tr></table><h3>Contact</h3><p>A contact in Gong is the contact associated with the account. Gong uses a contact to match an activity to the correct account.</p> <p>Mandatory parameters are marked with a <font color="red">*</font>.</p><p>To upload your CRM contacts to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color="red">*</font></td><td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a "-" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>modifiedDate <font color="red">*</font></td><td>The date and time the object was last modified in the CRM</td><td>ISO-8601 datetime format, without milliseconds</td></tr><tr><td>isDeleted</td><td>(Default: false) When true, the object is deleted from the database.</td><td>boolean</td></tr><tr><td>url</td><td>A full http URL to browse this object in the CRM</td><td>string (Qualified URI)</td></tr><tr><td>accountId</td><td>The ID of the account associated with the contact in the CRM. Used to associate an activity to an account once the activity has been associated with a contact.</td><td>string</td></tr><tr><td>emailAddress</td><td>The contact's email address. Used to associate activities to a contact, based on the participants email. </td><td>string</td></tr><tr><td>firstName</td><td>The contact's first name</td><td>string</td></tr><tr><td>lastName</td><td>The contact's last name</td><td>string</td></tr><tr><td>title</td><td>The contact's title</td><td>string</td></tr><tr><td>phoneNumber</td><td>The contact's phone number. Used to associate telephony system calls to a contact based on the call participant's phone number.</td><td>string</td></tr></table><h3>Deal</h3><p>A deal in Gong is a qualified opportunity or contract in a specific account.</p> <p>Mandatory parameters are marked with a <font color="red">*</font>.</p><p>To upload your deals to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color="red">*</font></td><td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a "-" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>modifiedDate <font color="red">*</font></td><td>The date and time the object was last modified in the CRM</td><td>ISO-8601 datetime format, without milliseconds</td></tr><tr><td>isDeleted</td><td>(Default: false) When true, the object is deleted from the database.</td><td>boolean</td></tr><tr><td>url</td><td>A full http URL to access this object in the CRM</td><td>string (Qualified URI)</td></tr><tr><td>accountId</td><td>The ID of the account the deal is associated with in the CRM. <br><b>Note</b>: Deals without an accountId will not appear in Gong</td><td>string</td></tr><tr><td>ownerId</td><td>The ID of the deal owner in the CRM. This ID should be the same as the business user objectId so the deal can be associated with the correct Gong user. <br><b>Note</b>: Deals without an ownerId will not appear in the deal board in Gong. </td><td>string</td></tr><tr><td>name</td><td>The deal name<br>Default value: Deal_# + objectId</td><td>string</td></tr><tr><td>createdDate</td><td>The date and time the deal was created in the CRM.</td><td>ISO-8601 datetime without milliseconds</td></tr><tr><td>closeDate</td><td>The date the deal closed or is expected to close. <br><b>Note</b>: Deals without a closeDate will not appear in the deal board in Gong.</td><td>string</td></tr><tr><td>status</td><td>The deal status. Possible values are: <ul><li>WON</li><li>LOST</li><li>OPEN</li></ul><br>Default value: OPEN</td><td>string</td></tr><tr><td>stage</td><td>The stage the deal is in. If empty, it will not always be possible to associate activities with deals. <br>Must be the same as one of the values in the objectId field in the stages object</td><td>string</td></tr><tr><td>amount</td><td>The deal amount in the currency unit. Companies set their default currency in the Company Settings page. All amounts should be sent in this currency. If your deal is in a different currency, convert the deal amount to the currency defined in the Company Settings page.<br>Default value: 0</td><td>currency</td></tr></table><h3>Lead</h3><p>A Lead is a potential customer, who may not yet be associated with an account. If conversations can't be associated with a contact, Gong then checks to see whether there is a relevant lead to associate with the conversation.</p> <p>Mandatory parameters are marked with a <font color="red">*</font>.</p><p>To upload your leads to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color="red">*</font></td><td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a "-" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>modifiedDate <font color="red">*</font></td><td>The date and time the object was last modified in the CRM</td><td>ISO-8601 datetime format, without milliseconds</td></tr><tr><td>isDeleted</td><td>(Default: false) When true, the object is deleted from the database.</td><td>boolean</td></tr><tr><td>url</td><td>A full http URL to browse this object in the CRM</td><td>string (Qualified URI)</td></tr><tr><td>emailAddress </td><td>The lead's email address. Used to associate activities to a lead, based on the participants email. </td><td>string</td></tr><tr><td>firstName </td><td>The lead's first name</td><td>string</td></tr><tr><td>lastName </td><td>The lead's last name</td><td>string</td></tr><tr><td>title</td><td>The lead's title</td><td>string</td></tr><tr><td>phoneNumber</td><td><p>The lead's phone number. Used to associated telephony system calls to a lead based on the call participant's phone number. </p><p></td><td>string</td></tr><tr><td>convertedToDealId</td><td>The deal ID in the CRM. Relevant if the lead is converted to a deal</td><td>string</td></tr><tr><td>convertedToContactId</td><td>The contact ID in the CRM the lead was converted to. Relevant if the lead is converted to a contact</td><td>string</td></tr><tr><td>convertedToAccountId</td><td>The account ID in the CRM the lead was converted to. Relevant if the lead is converted to an account</td><td>string</td></tr></table><h3>Stage</h3><p>The list of stages the deal can be in, in the CRM.  Stages are set to be active or inactive so that if you want to delete them, the stage is still associated with existing deals in that stage but will not be available for new deals. </p> <p>Mandatory parameters are marked with a <font color="red">*</font>.</p><p>To upload your stages to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color="red">*</font></td><td>The CRM unique ID for the object. <br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a "-" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>name <font color="red">*</font></td><td>The display name for the stage</td><td>string</td></tr><tr><td>isActive</td><td>When true, sets the stage to active in Gong. When false, sets the stage to inactive in Gong.<br>Default value: true</td><td>boolean</td></tr><tr><td>sortOrder</td><td>The order of the stage in the sales process (starting from 1). The stages are displayed according to this order. If two stages have the same sort order they will be displayed one after another. <br>Default value: 1</td><td>integer</td></tr></table><h2>Example</h2><h3>Upload Business User account</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=BUSINESS_USER<br>{"objectId": "user1_Id_In_The_CRM", "emailAddress": "john.doe@acme.com", "modifiedDate": "2019-01-03T23:45:57+01:00"}<br> // remove user mapping for user user2_Id_In_The_CRM<br>{"objectId": "user2_Id_In_The_CRM", "isDeleted": true, "emailAddress": "john.taylor@acme.com", "modifiedDate": "2019-01-03T23:45:57+01:00"}</code><h3>Upload Stage example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=STAGE<br>{"objectId": "discovery", "name": "Discovery", "isActive": true, "sortOrder": 1}<br>{"objectId": "won", "modifiedDate": "2019-01-03T23:45:57+01:00", "name": "Closed Won", "isActive": true, "sortOrder": 5}</code><h3>Upload Account example</h3><p><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=ACCOUNT<br>// account with additional field<br>{"objectId": "5ybyh6n6n65", "modifiedDate": "2019-01-03T23:45:57+01:00", "url": "https://crm.com/accounts/5ybyh6n6n65", "name": "PBR", "domains": ["pbr.com", "pbr.gov"], "type": "Investor"}<br>// remove account gfjhty756th from Gong <br>{"objectId": "gfjhty756th", "modifiedDate": "2019-01-03T22:45:57Z", "name": "PBR", "domains": ["pbr.com", "pbr.gov"], "isDeleted": true} </code><h3>Upload Contact example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=CONTACT<br>{"objectId": "5zbwd7n5n65", "modifiedDate": "2019-01-03T23:45:57+01:00", "url": "https://crm.com/contacts/5zbwd7n5n65", "accountId": "5ybyh6n6n65", "emailAddress": "john.smith@acme.com", "firstName": "john", "lastName": "smith", "phoneNumber": "(912) 507-4395"}</code><h3>Upload Lead example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=LEAD<br>{"objectId": "4v5bt54t553", "modifiedDate": "2019-01-03T23:45:57+01:00", "url": "https://crm.com/leads/45k4j5j5k44", "emailAddress": "jane.doe@acme.com", "firstName": "Jane", "lastName": "Doe", "title": "VP Special Effects", "phoneNumber": "(912) 507-4395"}<br>// remove lead gf4543gf6th<br>{"objectId": "gf4543gf6th", "modifiedDate": "2019-01-03T22:45:57Z", "emailAddress": "john.smith@acme.com", "firstName": "John", "lastName": "Smith", "isDeleted": true} <br>// lead 63473hjg53h converted to account 6sjk47jf78d, contact 87grhn74hg6 and deal dkfj8dfgf87<br>{"objectId": "63473hjg53h", "modifiedDate": "2019-01-03T23:45:57+01:00", "emailAddress": "bob.smith@acme.com", "firstName": "Bob", "lastName": "Smith", "convertedToDealId": "dkfj8dfgf87", "convertedToContactId": "87grhn74hg6", "convertedToAccountId": "6sjk47jf78d"} </code><h3>Upload Deal example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=DEAL<br>{"objectId": "8608553", "modifiedDate": "2022-02-04T18:24:59Z", "url": "http://crm.com/deals/8608553", "accountId": "5ybyh6n6n65", "ownerId": "5486951", "name": "Deal name", "createdDate": "2022-02-04T17:57:23Z", "closeDate": "2022-09-04", "status": OPEN, "stage": "discovery", "amount": 7000, "custom_field_1": "2022-02-04T17:57:23.000Z", "custom_field_2": null}</code><h3>Uploading additional fields</h3><p>If you defined additional fields using the <code>/v2/crm/entity-schema</code> API, include those fields in the JSON file.</p>

## OpenAPI

````json POST /v2/crm/entities
{
  "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": "<h3>Gong’s “Calls” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest calls details from Gong\n</li>\n<li>\nUpload new calls to Gong\n</li>\n<li>\nUpdate Gong Calls with new media\n</li>\n</ul>\n<h3>The requested calls may contain the following call details:</h3>\n<ul>\n<li>\n<b>Meta Data</b> (Basic details such as call date, title, call URL, etc)\n</li>\n<li>\n<b>Parties</b> (A list of the call's participants)\n</li>\n<li>\n<b>Media</b> (The media urls of the call)\n</li>\n<li>\n<b>Content</b> (Analysis of the interaction content)\n<ul>\n<li>\nAction Items (A list of action items)\n</li>\n<li>\nStructure (A list of the agenda of each part of the call)\n</li>\n<li>\nTopics (A list of topics and their durations)\n</li>\n<li>\nTrackers (A list of trackers found in the call. Trackers are collections of phrases defined in Gong for this company)\n</li>\n<li>\nPhrases (A list of occurrence counters for each specific phrase within the tracker (e.g., Amazon, Walmart))\n</li>\n<li>\nContext (A list of links to external systems such as CRM, Dialer, Case Management, etc)\n</li>\n</ul>\n</li>\n<li>\n<b>Interaction</b> (Metrics collected around the interaction during the call)\n<ul>\n<li>\nInteraction Stats (A list of interaction statistics. Applicable values: 'Talk Ratio', 'Longest Monologue', \n'Longest Customer Story', 'Interactivity', 'Patience')\n</li>\n<li>\nQuestions (Question counts of the call)\n</li>\n<li>\nSpeakers (A list of the talk duration per speaker)\n</li>\n<li>\nVideo (A list of video statistics about what's presented and for how long)\n</li>\n</ul>\n</li>\n<li>\n<b>Collaboration</b> (Collaboration information added to the call)\n<ul>\n<li>\nPublic Comments (A list of public comments)\n</li>\n</ul>\n</li>\n<li>\n<b>Context</b> (A list of links to external systems such as CRM, Dialer, Case Management, etc)\n<ul>\n<li>\nObjects (List of objects within the external system)\n</li>\n<li>\nFields (Object fields)\n</li>\n</ul>\n</li>\n</ul>\n"
    },
    {
      "name": "Users",
      "description": "<h3>Gong’s “Users” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest a list of all the company's users with details\n</li>\n<li>\nRequest a specific user’s history from Gong\n</li>\n</ul>\n<h3>The requested users may contain the following details:</h3>\n<ul>\n<li>\nIf the Gong user is active or not.\n</li>\n<li>\nCreation time of the Gong user.\n</li>\n<li>\nThe email address of the Gong user.\n</li>\n<li>\nList of email address aliases of the Gong user.\n</li>\n<li>\nThe extension number of the Gong user.\n</li>\n<li>\nThe first name of the Gong user.\n</li>\n<li>\nThe last name of the Gong user.\n</li>\n<li>\nGong's unique numeric identifier for the user.\n</li>\n<li>\nThe manager ID of the Gong user.\n</li>\n<li>\nThe Gong recording consent meeting link.\n</li>\n<li>\nThe list of personal meeting URLs of the Gong user.\n</li>\n<li>\nThe phone number of the Gong user.\n</li>\n<li>\nThe job title of the Gong user.\n</li>\n<li>\nThe user's settings.\n<ul>\n<li>\nIf the team member is set to import emails by Gong.\n</li>\n<li>\nIf the team member is set to prevent import of emails by Gong.\n</li>\n<li>\nIf the invitation of this user to a web conference will prevent its recording (even if other users invited are set to record).\n</li>\n<li>\nIf the team member is set to import telephony calls by Gong.\n</li>\n<li>\nIf the team member is set to be recorded by Gong.\n</li>\n</ul>\n</li>\n<li>\nThe User's settings history.\n<ul>\n<li>\nThe user capability that was changed.\n</li>\n<li>\nThe date and time the action was set.\n</li>\n<li>\nThe new value that was set.\n</li>\n</ul>\n</li>\n</ul>\n"
    },
    {
      "name": "Stats",
      "description": "<h3>Gong’s “Stats” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest user activity\n</li>\n<li>\nRequest scorecards activity\n</li>\n<li>\nRequest interaction stats on calls that have Whisper turned on\n</li>\n</ul>\n<h3>The requested user activity may contain the following details:</h3>\n<ul>\n<li>\n<b>Calls Hosted:</b> The number of recorded calls this user hosted.\n</li>\n<li>\n<b>Call Participated:</b> The number of calls in which this user is a participant (not host).\n</li>\n<li>\n<b>Calls Reviewed:</b> The number of calls in which someone pressed the \"Mark as reviewed\".\n</li>\n<li>\n<b>Calls Listened:</b> The number of other users' calls the user listened to.\n</li>\n<li>\n<b>Call Shared Outside:</b> The number of calls the user shared with others outside the company.\n</li>\n<li>\n<b>Call Shared Inside:</b> The number of calls the user shared with others inside the company.\n</li>\n<li>\n<b>Own Calls Listened:</b> The number of the user's own calls the user listened to.\n</li>\n<li>\n<b>Comment Given:</b> The number of calls in which a user gave at least one comment.\n</li>\n<li>\n<b>Comment Received:</b> The number of calls in which a user received at least one comment on the users calls.\n</li>\n<li>\n<b>Feedback Given:</b> The number of recorded calls the user gave feedback on.\n</li>\n<li>\n<b>Feedback Received:</b> The number of recorded calls the user received feedback on.\n</li>\n<li>\n<b>Feedback Requested:</b> The number of recorded calls the user requested feedback on.\n</li>\n<li>\n<b>Scorecard Filled:</b> The number of calls in which someone filled a scorecard on the user's calls.\n</li>\n<li>\n<b>Scorecards Completed:</b> The number of scorecards the user completed.\n</li>\n<li>\n<b>Scorecards Answers:</b> The answers in the answered scorecard.\n</li>\n<li>\n<b>Whisper:</b> Person Interaction Stats (List of user interaction stats. Applicable values: 'Talk Ratio',\n 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Question Rate', 'Patience').\n</li>\n</ul>\n"
    },
    {
      "name": "Settings",
      "description": "<h3>Gong’s “Settings” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest all the scorecards within the Gong system.\n</li>\n<li>\nRequest all the workspaces including their details.\n</li>\n</ul>\n"
    },
    {
      "name": "Data Privacy",
      "description": "<h3>Gong’s “Data Privacy” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest all references to an email address.\n</li>\n<li>\nRequest all references to a phone number.\n</li>\n<li>\nDelete the email address, and all associated elements.\n</li>\n<li>\nDelete the phone number, and all associated elements.\n</li>\n</ul>\n"
    },
    {
      "name": "Library",
      "description": "<h3>Gong’s “Library” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest all the calls in a specific folder.\n</li>\n<li>\nRequest all the Library folders. We do not allow retrieval of either private or archived folders.\n</li>\n</ul>\n"
    },
    {
      "name": "CRM",
      "description": "<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}img {  border: 2px solid #D3D5D9;}</style><p>If you are using the deprecated endpoints, download the <a href=\"/r/img/permanent/crm_api_deprecated_endpoints.pdf\" target=\"_blank\">PDF file</a>.</p><h1>What does the CRM API do?</h1><p>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:</p><ul>  <li>Pipeline review and forecast</li>  <li>Narrow down conversations (calls and emails) by customer data for coaching and analytics</li>  <li>Track initiatives and adoption based on accounts and opportunities</li></ul><p>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.</p><p><b>Note</b>: Gong provides native integrations with Salesforce, HubSpot and Microsoft Dynamics 365.</p><h2>API Protocol</h2>The API protocol is based on REST guidelines. Check <a href=\"https://app.gong.io/company/api-authentication?currentTab=MY_API_TAB\">here</a> what's your base URL for all API calls.\n<p>The payload is either a JSON object or, for API calls that upload lists of objects, line delimited JSON (see: <a href=\"https://en.wikipedia.org/wiki/JSON_streaming#Newline-Delimited_JSON\">JSON streaming</a>). JSON objects should be UTF-8 encoded.</p><p>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).</p><h2>What data can I upload?</h2><p>To see your CRM data in Gong, upload the following entities:</p><ul>  <li>Business User: The CRM user, such as a seller or manager. </li>  <li>Account: The customer details in the CRM</li>  <li>Contact: A specific contact in the CRM that is associated with a customer</li>  <li>Deal: A deal or opportunity, or a contract of a specific account in the CRM</li>  <li>Lead: A potential customers who are not associated with an account</li>  <li>Stage: The list of stages the deal can be in, in your CRM</li></ul><h2>Uploading CRM data to Gong</h2><p>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.</p><img alt=\"\" src=\"/r/img/permanent/crm_api_flow.png\" height=\"95%\" ><h3>Registering your Integration</h3><p>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.</p><p>Use <code>PUT v2/crm/integrations</code> to register your integration. The integration Id is returned in the response. Include the integration Id each time you upload your CRM data.</p><h3>Uploading additional data for CRM entities</h3><p>Each CRM entity has a set of standard fields. In addition, you may want to upload additional fields.</p><p>Use the <code>POST /v2/crm/entity-schema</code> 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.</p><h3>Uploading your CRM data to Gong</h3><p>This section explains how you can use the CRM API to upload your data to Gong:</p><h4>First-time upload</h4><p>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.</p><h4>Incremental upload </h4><p>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.<br>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.</p><p>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.</p><h4>Uploading data change history</h4><p>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.</p><p>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:</p><ol>  <li>Generate the JSON files with the relevant data. Ensure that the modifiedDate is set to the date the entity was updated.</li>  <li>Upload the entities with their historical data using the <code>POST /v2/crm/entities?objectType=ACCOUNT|CONTACT|DEAL|LEAD</code> endpoint.</li></ol><h2>Gong Data Model</h2><p>This diagram shows the connection between the different objects in the CRM API:</p><img alt=\"\" src=\"/r/img/permanent/crm_api_model.png\" height=\"80%\"><p>The following relationship between entities must exist:</p><ul>  <li>A contact must be linked to a single account.</li>  <li>A deal is linked to a single account.</li>  <li>A deal has an owner who is a user in Gong.</li>  <li>A converted lead is expected to be converted into an account and/or a deal and/or a contact.</li></ul><h2>What if my CRM doesn't match the Gong data model?</h2><p>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.</p><p>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.</p><p>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.</p><p>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.</p><p>The deal represents the selling process to the customer (account).</p><p>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.</p><h2>When will my CRM data be displayed in Gong?</h2><p>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.</p><br><br><br><br>"
    },
    {
      "name": "Auditing",
      "description": "<h3>Gong’s “Auditing” API endpoints allow you to request the following log types from Gong:</h3>\n<ul>\n<li>\nAccess Log - This log is preserved for 14 days only\n</li>\n<li>\nUser Activity Log - The data is available since March 2021\n</li>\n<li>\nUser Call Play Log - All data is available since inception\n</li>\n<li>\nExternally Shared Call Access Log - All data is available since inception\n</li>\n<li>\nExternally Shared Call Play Log - All data is available since inception\n</li>\n</ul>\n"
    },
    {
      "name": "Meetings (in Beta Phase)",
      "description": "<h3>Gong’s “Consent Meeting” API endpoints allow you to:</h3>\n<ul>\n<li>\nRequest creating a Gong Consent meeting link\n</li>\n<li>\nUpdate a Consent Meeting’s details\n</li>\n<li>\nDelete a Consent Meeting\n</li>\n<li>\nList all Licensed Users in the Gong instance and their Consent Page status\n</li>\n</ul>\n<h3>The requested calls may contain the following meeting details:</h3>\n<ul>\n<li>\nMeeting Scheduled Start Time\n</li>\n<li>\nMeeting Scheduled End Time\n</li>\n<li>\nOrganizer\n</li>\n<li>\nMeeting Title\n</li>\n<li>\nInvitees\n</li>\n<li>\nExternal Meeting Id - The ID as it is formed on an external system\n</li>\n</ul>\n"
    },
    {
      "name": "Permissions",
      "description": "<h3>Gong’s \"Permission\" API endpoints allow you to:</h3>\n<ul>\n<li>\nList all permission profiles in a given workspace\n</li>\n<li>\nCreate permission profile\n</li>\n<li>\nGet a permission profile\n</li>\n<li>\nUpdate permission profile\n</li>\n<li>\nList all users controlled by a permission profile\n</li>\n<li>\nAllow users individual access to calls\n</li>\n<li>\nRemove user's individual access to calls\n</li>\n<li>\nRetrieve users that have individual access to calls\n</li>\n</ul>\n"
    },
    {
      "name": "Engage Flows",
      "description": "<h3>Gong’s “Flows” API endpoints allow you to:</h3>\n<ul>\n<li>\nView a list of relevant Gong Engage flows to choose from and the current flow assignment status\n</li>\n<li>\nAdd prospects to Gong Engage flows\n</li>\n</ul>\n"
    },
    {
      "name": "Digital Interactions",
      "description": "<p>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. </p><p>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. </p><p> 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:</p><ul>  <li>Event: Represents something that happened, described as an action verb + content engaged (e.g., \"signed a contract\").</li>  <li>Content: Refers to the specific content engaged during the event (e.g., contract). Provides details such as label, title, ID, and URLs.</li>  <li>Person: Represents the individual responsible for the action. Can be a known person or an anonymous user associated with a company.</li>  <li>Content Custom Fields: Custom properties for the content. Example: Custom field - \"Version: 2.0\", Custom field - \"Author: Jane Smith\".</li>  <li>Company: Refers to the organization associated with the person. Example: Company ID - \"7890\", Company name - \"XYZ Corp\".</li>  <li>Partner: An external collaborating organization that owns a software product involved in the digital interactions captured by the API.</li></ul>"
    },
    {
      "name": "Integration Settings",
      "description": "<p>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.</p><p>Mandatory fields are marked with a *.</p>"
    },
    {
      "name": "Engagement (Legacy – See “Digital Interactions”)",
      "description": "<h3>Limited release - contact <a href=\"mailto:integration.requests@gong.io\">integration.requests@gong.io</a> for more information.\n</h3>\n\n<h3>Gong’s \"Engagement\" API endpoints allow you to push engagement events into Gong and display them as events in Gong’s activity timeline.</h3>\n<h3>There are currently 3 types of events:</h3>\n<ul>\n<li>\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)</li>\n<li>\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</li>\n<li>\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)</li>\n</ul>\n"
    }
  ],
  "paths": {
    "/v2/crm/entities": {
      "post": {
        "operationId": "uploadCrmData",
        "summary": "Upload CRM objects (/v2/crm/entities)",
        "description": "<style>.public-api-info {    background: rgb(222, 235, 255);}.public-api-tip {    background: rgb(227, 252, 239);}.public-api-parameter {    background: rgba(9,30,66,0.08);}.public-api-note {    background: rgb(234, 230, 255);}.public-api-important {    background: rgb(255, 250, 230);}.public-api-critical {    background: rgb(255, 235, 230);}table, th, td {  border: 1px solid gray;  border-collapse: collapse;}th, td {  padding: 5px;}th {  text-align: left;}img {  border: 2px solid #D3D5D9;}</style><p>Inserts, updates, or deletes a CRM entity in Gong.</p><p>Gong searches for existing entities with the same ID, to determine whether the entity should be added or updated.</p><p>Ensure you have an authentication key and that you have registered your integration before uploading your CRM data.</p><p>When accessed using a bearer token, this endpoint requires the 'api:crm:upload' scope.</p><h2>Request parameters</h2> <h3>Query String parameters</h3><p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>integrationId <font color=\"red\">*</font></td>    <td>Integration ID generated when creating the integration</td>    <td>long</td>  </tr>  <tr>    <td>objectType <font color=\"red\">*</font></td>    <td>The object being uploaded. Options are (case-sensitive): <br><ul><li>ACCOUNT</li><li>CONTACT</li><li>DEAL</li><li>LEAD</li><li>BUSINESS_USER</li><li>STAGE</li></ul> </td>    <td>string</td>  </tr>  <tr>    <td>clientRequestId\t<font color=\"red\">*</font></td>    <td>A unique identifier sent by you to allow troubleshooting and to prevent repeated attempts to upload the same list of objects.<br>Valid characters: letters, numbers, dashes and underscores.</td>    <td>string</td>  </tr></table><h2>Request Body</h2><ul>  <li>Content-Type should be multipart/form-data</li>  <li>Maximum payload size: 200 megabytes</li></ul><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>dataFile <font color=\"red\">*</font></td>    <td>The LDJSON file with the entity data to upload. A file should only contain objects of one entity type. Records that have multiple updates should be sent in separate files. Each JSON object should be on a separate line. </td>    <td>file</td>  </tr></table><h2>CRM Entities</h2><p>This section details the entities that can be uploaded to Gong </p><h3>Business User</h3><p>The CRM business user represents the Gong user in the CRM and is responsible for the relationship with the account and for creating opportunities and closing deals. Uploading business users enables Gong to associate CRM entities such as accounts and contacts with the relevant user in Gong and with their Gong activity, such as conversations. </p><p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><p>To upload your business users to Gong, generate a JSON file with the following fields:</p><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>objectId <font color=\"red\">*</font></td>    <td>The CRM unique ID for the object. <br>Note: objectId can have a maximum of 64 characters and can have the following characters:       <ul>        <li>alpha numeric characters and a \"-\" </li>        <li>a valid email address</li>      </ul>No other special characters can be used    </td>    <td>string</td>  </tr>  <tr>    <td>modifiedDate <font color=\"red\">*</font></td>    <td>The date and time the object was last modified in the CRM</td>    <td>ISO-8601 datetime format, without milliseconds</td>  </tr>  <tr>    <td>isDeleted</td>    <td>(Default: false) When true, the object is deleted from the database.</td>    <td>boolean</td>  </tr>  <tr>    <td>url</td>    <td>The full URL path to view this object in the CRM</td>    <td>string (Qualified URI)</td>  </tr>  <tr>    <td>emailAddress <font color=\"red\">*</font></td>    <td>The business user's email address. Used to associate the Gong user with the CRM user. Not mandatory when isDeleted = true.</td>    <td>string</td>  </tr></table><h4>Associating the Gong user with the CRM user</h4><p>The CRM user is associated with the Gong user according to the email address. Each CRM deal contains an ownerId field, which is the CRM user ID.</p><p>To update an existing user:</p><ol>  <li>Delete the existing user by uploading the business user entity with isDeleted=true.</li>  <li>In a new request, send the new user details with isDeleted=false, or send a different user with the same email address.</li></ol><h3>Account</h3><p>The account object is an active customer in the CRM. Emails and calls in Gong are associated with this account object.</p><p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><p>To upload your CRM accounts to Gong, generate a JSON file with the following fields:</p><table>  <tr>    <th>Name</th>    <th>Description</th>    <th>Data Type</th>  </tr>  <tr>    <td>objectId <font color=\"red\">*</font></td>    <td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters:       <ul>        <li>alpha numeric characters and a \"-\" </li>        <li>a valid email address</li>      </ul>No other special characters can be used    </td>    <td>string</td>  </tr>  <tr>    <td>modifiedDate <font color=\"red\">*</font></td>    <td>The date and time the object was last modified in the CRM</td>    <td>ISO-8601 datetime format, without milliseconds</td>  </tr>  <tr>    <td>isDeleted</td>    <td>(Default: false) When true, the object is deleted from the database</td>    <td>boolean</td>  </tr>  <tr>    <td>url</td>    <td>A full http URL to browse this object in the CRM</td>    <td>string (Qualified URI)</td>  </tr>  <tr>    <td>name</td>    <td>The account name. <br>Default value: \"Account_#\"+objectId</td>    <td>string</td>  </tr>  <tr>    <td>domains</td>    <td>The account's domain/s. When an activity can’t be associated with a contact, the participants domain is used to associate the activity to an account via the account domain in this field.</td>    <td>string array</td>  </tr></table><h3>Contact</h3><p>A contact in Gong is the contact associated with the account. Gong uses a contact to match an activity to the correct account.</p> <p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><p>To upload your CRM contacts to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color=\"red\">*</font></td><td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a \"-\" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>modifiedDate <font color=\"red\">*</font></td><td>The date and time the object was last modified in the CRM</td><td>ISO-8601 datetime format, without milliseconds</td></tr><tr><td>isDeleted</td><td>(Default: false) When true, the object is deleted from the database.</td><td>boolean</td></tr><tr><td>url</td><td>A full http URL to browse this object in the CRM</td><td>string (Qualified URI)</td></tr><tr><td>accountId</td><td>The ID of the account associated with the contact in the CRM. Used to associate an activity to an account once the activity has been associated with a contact.</td><td>string</td></tr><tr><td>emailAddress</td><td>The contact's email address. Used to associate activities to a contact, based on the participants email. </td><td>string</td></tr><tr><td>firstName</td><td>The contact's first name</td><td>string</td></tr><tr><td>lastName</td><td>The contact's last name</td><td>string</td></tr><tr><td>title</td><td>The contact's title</td><td>string</td></tr><tr><td>phoneNumber</td><td>The contact's phone number. Used to associate telephony system calls to a contact based on the call participant's phone number.</td><td>string</td></tr></table><h3>Deal</h3><p>A deal in Gong is a qualified opportunity or contract in a specific account.</p> <p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><p>To upload your deals to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color=\"red\">*</font></td><td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a \"-\" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>modifiedDate <font color=\"red\">*</font></td><td>The date and time the object was last modified in the CRM</td><td>ISO-8601 datetime format, without milliseconds</td></tr><tr><td>isDeleted</td><td>(Default: false) When true, the object is deleted from the database.</td><td>boolean</td></tr><tr><td>url</td><td>A full http URL to access this object in the CRM</td><td>string (Qualified URI)</td></tr><tr><td>accountId</td><td>The ID of the account the deal is associated with in the CRM. <br><b>Note</b>: Deals without an accountId will not appear in Gong</td><td>string</td></tr><tr><td>ownerId</td><td>The ID of the deal owner in the CRM. This ID should be the same as the business user objectId so the deal can be associated with the correct Gong user. <br><b>Note</b>: Deals without an ownerId will not appear in the deal board in Gong. </td><td>string</td></tr><tr><td>name</td><td>The deal name<br>Default value: Deal_# + objectId</td><td>string</td></tr><tr><td>createdDate</td><td>The date and time the deal was created in the CRM.</td><td>ISO-8601 datetime without milliseconds</td></tr><tr><td>closeDate</td><td>The date the deal closed or is expected to close. <br><b>Note</b>: Deals without a closeDate will not appear in the deal board in Gong.</td><td>string</td></tr><tr><td>status</td><td>The deal status. Possible values are: <ul><li>WON</li><li>LOST</li><li>OPEN</li></ul><br>Default value: OPEN</td><td>string</td></tr><tr><td>stage</td><td>The stage the deal is in. If empty, it will not always be possible to associate activities with deals. <br>Must be the same as one of the values in the objectId field in the stages object</td><td>string</td></tr><tr><td>amount</td><td>The deal amount in the currency unit. Companies set their default currency in the Company Settings page. All amounts should be sent in this currency. If your deal is in a different currency, convert the deal amount to the currency defined in the Company Settings page.<br>Default value: 0</td><td>currency</td></tr></table><h3>Lead</h3><p>A Lead is a potential customer, who may not yet be associated with an account. If conversations can't be associated with a contact, Gong then checks to see whether there is a relevant lead to associate with the conversation.</p> <p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><p>To upload your leads to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color=\"red\">*</font></td><td>The CRM unique ID for the object.<br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a \"-\" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>modifiedDate <font color=\"red\">*</font></td><td>The date and time the object was last modified in the CRM</td><td>ISO-8601 datetime format, without milliseconds</td></tr><tr><td>isDeleted</td><td>(Default: false) When true, the object is deleted from the database.</td><td>boolean</td></tr><tr><td>url</td><td>A full http URL to browse this object in the CRM</td><td>string (Qualified URI)</td></tr><tr><td>emailAddress </td><td>The lead's email address. Used to associate activities to a lead, based on the participants email. </td><td>string</td></tr><tr><td>firstName </td><td>The lead's first name</td><td>string</td></tr><tr><td>lastName </td><td>The lead's last name</td><td>string</td></tr><tr><td>title</td><td>The lead's title</td><td>string</td></tr><tr><td>phoneNumber</td><td><p>The lead's phone number. Used to associated telephony system calls to a lead based on the call participant's phone number. </p><p></td><td>string</td></tr><tr><td>convertedToDealId</td><td>The deal ID in the CRM. Relevant if the lead is converted to a deal</td><td>string</td></tr><tr><td>convertedToContactId</td><td>The contact ID in the CRM the lead was converted to. Relevant if the lead is converted to a contact</td><td>string</td></tr><tr><td>convertedToAccountId</td><td>The account ID in the CRM the lead was converted to. Relevant if the lead is converted to an account</td><td>string</td></tr></table><h3>Stage</h3><p>The list of stages the deal can be in, in the CRM.  Stages are set to be active or inactive so that if you want to delete them, the stage is still associated with existing deals in that stage but will not be available for new deals. </p> <p>Mandatory parameters are marked with a <font color=\"red\">*</font>.</p><p>To upload your stages to Gong, generate a JSON file with the following fields:</p><table><tr><th>Name</th><th>Description</th><th>Data Type</th></tr><tr><td>objectId <font color=\"red\">*</font></td><td>The CRM unique ID for the object. <br>Note: objectId can have a maximum of 64 characters and can have the following characters: <ul><li>alpha numeric characters and a \"-\" </li><li>a valid email address</li></ul>No other special characters can be used</td><td>string</td></tr><tr><td>name <font color=\"red\">*</font></td><td>The display name for the stage</td><td>string</td></tr><tr><td>isActive</td><td>When true, sets the stage to active in Gong. When false, sets the stage to inactive in Gong.<br>Default value: true</td><td>boolean</td></tr><tr><td>sortOrder</td><td>The order of the stage in the sales process (starting from 1). The stages are displayed according to this order. If two stages have the same sort order they will be displayed one after another. <br>Default value: 1</td><td>integer</td></tr></table><h2>Example</h2><h3>Upload Business User account</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=BUSINESS_USER<br>{\"objectId\": \"user1_Id_In_The_CRM\", \"emailAddress\": \"john.doe@acme.com\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\"}<br> // remove user mapping for user user2_Id_In_The_CRM<br>{\"objectId\": \"user2_Id_In_The_CRM\", \"isDeleted\": true, \"emailAddress\": \"john.taylor@acme.com\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\"}</code><h3>Upload Stage example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=STAGE<br>{\"objectId\": \"discovery\", \"name\": \"Discovery\", \"isActive\": true, \"sortOrder\": 1}<br>{\"objectId\": \"won\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"name\": \"Closed Won\", \"isActive\": true, \"sortOrder\": 5}</code><h3>Upload Account example</h3><p><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=ACCOUNT<br>// account with additional field<br>{\"objectId\": \"5ybyh6n6n65\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"url\": \"https://crm.com/accounts/5ybyh6n6n65\", \"name\": \"PBR\", \"domains\": [\"pbr.com\", \"pbr.gov\"], \"type\": \"Investor\"}<br>// remove account gfjhty756th from Gong <br>{\"objectId\": \"gfjhty756th\", \"modifiedDate\": \"2019-01-03T22:45:57Z\", \"name\": \"PBR\", \"domains\": [\"pbr.com\", \"pbr.gov\"], \"isDeleted\": true} </code><h3>Upload Contact example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=CONTACT<br>{\"objectId\": \"5zbwd7n5n65\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"url\": \"https://crm.com/contacts/5zbwd7n5n65\", \"accountId\": \"5ybyh6n6n65\", \"emailAddress\": \"john.smith@acme.com\", \"firstName\": \"john\", \"lastName\": \"smith\", \"phoneNumber\": \"(912) 507-4395\"}</code><h3>Upload Lead example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=LEAD<br>{\"objectId\": \"4v5bt54t553\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"url\": \"https://crm.com/leads/45k4j5j5k44\", \"emailAddress\": \"jane.doe@acme.com\", \"firstName\": \"Jane\", \"lastName\": \"Doe\", \"title\": \"VP Special Effects\", \"phoneNumber\": \"(912) 507-4395\"}<br>// remove lead gf4543gf6th<br>{\"objectId\": \"gf4543gf6th\", \"modifiedDate\": \"2019-01-03T22:45:57Z\", \"emailAddress\": \"john.smith@acme.com\", \"firstName\": \"John\", \"lastName\": \"Smith\", \"isDeleted\": true} <br>// lead 63473hjg53h converted to account 6sjk47jf78d, contact 87grhn74hg6 and deal dkfj8dfgf87<br>{\"objectId\": \"63473hjg53h\", \"modifiedDate\": \"2019-01-03T23:45:57+01:00\", \"emailAddress\": \"bob.smith@acme.com\", \"firstName\": \"Bob\", \"lastName\": \"Smith\", \"convertedToDealId\": \"dkfj8dfgf87\", \"convertedToContactId\": \"87grhn74hg6\", \"convertedToAccountId\": \"6sjk47jf78d\"} </code><h3>Upload Deal example</h3><code>POST https://api.gong.io/v2/crm/entities?clientRequestId=1234&integrationId=6286478263646&objectType=DEAL<br>{\"objectId\": \"8608553\", \"modifiedDate\": \"2022-02-04T18:24:59Z\", \"url\": \"http://crm.com/deals/8608553\", \"accountId\": \"5ybyh6n6n65\", \"ownerId\": \"5486951\", \"name\": \"Deal name\", \"createdDate\": \"2022-02-04T17:57:23Z\", \"closeDate\": \"2022-09-04\", \"status\": OPEN, \"stage\": \"discovery\", \"amount\": 7000, \"custom_field_1\": \"2022-02-04T17:57:23.000Z\", \"custom_field_2\": null}</code><h3>Uploading additional fields</h3><p>If you defined additional fields using the <code>/v2/crm/entity-schema</code> API, include those fields in the JSON file.</p>",
        "requestBody": {
          "required": true,
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "dataFile": {
                    "description": "The CRM data file. You may attach files up to 200MB in size",
                    "type": "string",
                    "format": "binary"
                  }
                },
                "required": [
                  "dataFile"
                ]
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successfully uploaded the crm data.<br>Important: This API is asynchronous. A 201 response indicates that the file successfully uploaded to Gong and is pending processing. Use the clientRequestId to verify the status of the request by calling the GET /v2/crm/request-status endpoint.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AsyncProcessingResponse"
                }
              }
            }
          },
          "400": {
            "description": "Malformed request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Access denied",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "409": {
            "description": "Client request id has already been used",
            "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": {
      "AsyncProcessingResponse": {
        "type": "object",
        "properties": {
          "requestId": {
            "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.",
            "type": "string",
            "example": "4al018gzaztcr8nbukw"
          },
          "clientRequestId": {
            "description": "The clientRequestId sent in the request - used to monitor the request process",
            "type": "string",
            "example": "clientRequest1"
          }
        }
      },
      "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"
            ]
          }
        }
      }
    }
  }
}
````