Client app access token from POST https://auth.siro.ai/oauth2/token, or a legacy organization API token (Person icon → API Tokens). Send Authorization: Bearer <token>.
The status of the engagement in the external system, stored verbatim (eg. a Salesforce ServiceAppointment "Status" picklist label). Values are platform- and org-specific, so they are not normalized or comparable across connections.
start dateTime of the engagement. Include a UTC offset or "Z" (e.g. 2026-09-20T14:00:00-04:00) to state the instant exactly. An offset-less value (e.g. 2026-09-20T14:00:00) is read as wall-clock time in the integration connection's defaultTimezone when one is set, otherwise as UTC.
Localized dateTime of the engagement, without timezone info. When present, the frontend will display this as-is without timezone conversion, overriding startTime for display purposes. Set automatically from the wall-clock value when the connection's defaultTimezone is applied.
Internal SIRO engagementTypeId override for this engagement. OPTIONAL -- only use if you know the internal value of the engagement type as it will override the engagementType object args.
(DEPRECATED IN FAVOR OF engagementContacts ARRAY) The associated contact for this engagement. Note: supplying just an externalId will resolve to an already-synced contact
Platform-specific data with no column of its own, eg. identifiers writeback needs that the Siro links do not name. Prefer an object -- the column is jsonb, and the legacy string form stores a scalar that cannot be queried into. Omit to leave any stored value untouched.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Starter Kit","colors":{"primary":"#F2A710","light":"#F2A710","dark":"#F2A710"},"logo":{"light":"https://mintcdn.com/siro-508e7b35/YTBFBZtqg9vKFzK0/logo/light.svg?fit=max\u0026auto=format\u0026n=YTBFBZtqg9vKFzK0\u0026q=85\u0026s=57a3776ced9577d8a79264b5ca264487","dark":"https://mintcdn.com/siro-508e7b35/YTBFBZtqg9vKFzK0/logo/dark.svg?fit=max\u0026auto=format\u0026n=YTBFBZtqg9vKFzK0\u0026q=85\u0026s=ef0a61765e8d0e666443f39ae794239b"},"favicon":"https://mintcdn.com/siro-508e7b35/xcAxl1V8xdtCXS7u/favicon.svg?fit=max\u0026auto=format\u0026n=xcAxl1V8xdtCXS7u\u0026q=85\u0026s=91ad75b678bedc531dec15cb67eb7cad","api":{"openapi":["specs/openapi-externalApi.json","specs/openapi-internalApi.json","specs/openapi-auth.json","specs/webhooks.json"]},"navbar":{"links":[{"href":"mailto:support@siro.ai","label":"Support"}],"primary":{"type":"button","label":"Siro Web","href":"https://app.siro.ai"}},"footer":{"socials":{"instagram":"https://www.instagram.com/siro_app","linkedin":"https://www.linkedin.com/company/siro-ai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"siro-508e7b35","hasAudioNarration":false,"actualSubdomain":"siro-508e7b35","customDomains":["docs.siro.ai"],"gitSource":{"type":"github","owner":"siro-ai","repo":"external-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adbc640891aaf1ef070dd96","collectionId":"20254db8-b0c0-4185-be05-67e09a081a43","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adbc640891aaf1ef070dd96"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adbc640891aaf1ef070dd96","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API References","count":82},{"language":"default","tag":"Org-wide API","count":60},{"language":"default","tag":"Core","count":58},{"language":"default","tag":"Documentation","count":29},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"User-scoped API","count":19},{"language":"default","tag":"Engagements","count":9},{"language":"default","tag":"Opportunities","count":9},{"language":"default","tag":"Recordings","count":9},{"language":"default","tag":"OAuth Apps and Tokens","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-references/sync-an-engagement","slug":"/api-references/sync-an-engagement","pageMetadata":{"openapi":"put /v1/integrations/sync/engagements","title":"Sync an engagement","description":"Sync an engagement","href":"/api-references/sync-an-engagement"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Sync an engagement\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"put /v1/integrations/sync/engagements","title":"Sync an engagement","description":"Sync an engagement","href":"/api-references/sync-an-engagement"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/siro-508e7b35/da61a0c56068d303/update-openapi.js"],"openApiReferenceData":{"operation":{"summary":"Sync an engagement","description":"Sync an engagement","requestBody":"50bca07c-1972-4303-8aad-c3ae4fc8b00b","responses":{"200":"2b672d3c-7723-4c89-8eb4-f237db01d3a8"},"security":["70b481ee-eeb7-4965-8076-3b51f48a1c85"],"method":"put","type":"path","servers":["b599d88f-5634-48d6-8ef5-4cc68579ecc0"],"path":"/v1/integrations/sync/engagements","baseUrlOptions":["https://functions.siro.ai/api-externalApi"],"title":"Sync an engagement","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the engagement in the external system","isRequired":true,"uniqueKey":"externalId","typeLabel":"string"},"direction":{"oneOf":[{"type":"string","enum":["INBOUND","OUTBOUND"],"description":"The direction of the engagement (INBOUND/OUTBOUND)","uniqueKey":"direction.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["INBOUND","OUTBOUND"],"description":"The direction of the engagement (INBOUND/OUTBOUND)","uniqueKey":"direction.oneOf.1","typeLabel":"null"}],"uniqueKey":"direction","typeLabel":"enum\u003cstring> | null"},"content":{"oneOf":[{"type":"string","description":"The content of the engagement","uniqueKey":"content.oneOf.0","typeLabel":"string"},{"type":"null","description":"The content of the engagement","uniqueKey":"content.oneOf.1","typeLabel":"null"}],"uniqueKey":"content","typeLabel":"string | null"},"subject":{"oneOf":[{"type":"string","description":"The subject of the engagement","uniqueKey":"subject.oneOf.0","typeLabel":"string"},{"type":"null","description":"The subject of the engagement","uniqueKey":"subject.oneOf.1","typeLabel":"null"}],"uniqueKey":"subject","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","description":"The status of the engagement in the external system, stored verbatim (eg. a Salesforce ServiceAppointment \"Status\" picklist label). Values are platform- and org-specific, so they are not normalized or comparable across connections.","uniqueKey":"status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The status of the engagement in the external system, stored verbatim (eg. a Salesforce ServiceAppointment \"Status\" picklist label). Values are platform- and org-specific, so they are not normalized or comparable across connections.","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"string | null"},"startTime":{"oneOf":[{"type":"string","description":"start dateTime of the engagement. Include a UTC offset or \"Z\" (e.g. 2026-09-20T14:00:00-04:00) to state the instant exactly. An offset-less value (e.g. 2026-09-20T14:00:00) is read as wall-clock time in the integration connection's defaultTimezone when one is set, otherwise as UTC.","uniqueKey":"startTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"start dateTime of the engagement. Include a UTC offset or \"Z\" (e.g. 2026-09-20T14:00:00-04:00) to state the instant exactly. An offset-less value (e.g. 2026-09-20T14:00:00) is read as wall-clock time in the integration connection's defaultTimezone when one is set, otherwise as UTC.","uniqueKey":"startTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"startTime","typeLabel":"string | null"},"startTimeLocalized":{"oneOf":[{"type":"string","description":"Localized dateTime of the engagement, without timezone info. When present, the frontend will display this as-is without timezone conversion, overriding startTime for display purposes. Set automatically from the wall-clock value when the connection's defaultTimezone is applied.","uniqueKey":"startTimeLocalized.oneOf.0","typeLabel":"string"},{"type":"null","description":"Localized dateTime of the engagement, without timezone info. When present, the frontend will display this as-is without timezone conversion, overriding startTime for display purposes. Set automatically from the wall-clock value when the connection's defaultTimezone is applied.","uniqueKey":"startTimeLocalized.oneOf.1","typeLabel":"null"}],"uniqueKey":"startTimeLocalized","typeLabel":"string | null"},"endTime":{"oneOf":[{"type":"string","description":"end dateTime of the engagement. Interpreted the same way as startTime.","uniqueKey":"endTime.oneOf.0","typeLabel":"string"},{"type":"null","description":"end dateTime of the engagement. Interpreted the same way as startTime.","uniqueKey":"endTime.oneOf.1","typeLabel":"null"}],"uniqueKey":"endTime","typeLabel":"string | null"},"remoteCreatedAt":{"oneOf":[{"type":"string","description":"external engagement creation datetime","uniqueKey":"remoteCreatedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"external engagement creation datetime","uniqueKey":"remoteCreatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"remoteCreatedAt","typeLabel":"string | null"},"remoteUpdatedAt":{"oneOf":[{"type":"string","description":"external engagement update datetime","uniqueKey":"remoteUpdatedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"external engagement update datetime","uniqueKey":"remoteUpdatedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"remoteUpdatedAt","typeLabel":"string | null"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system. Use to represent if an engagement was cancelled.","uniqueKey":"deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system. Use to represent if an engagement was cancelled.","uniqueKey":"deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"deletedAt","typeLabel":"string\u003cdate-time> | null"},"engagementTypeId":{"oneOf":[{"type":"string","description":"Internal SIRO engagementTypeId override for this engagement. OPTIONAL -- only use if you know the internal value of the engagement type as it will override the engagementType object args.","uniqueKey":"engagementTypeId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal SIRO engagementTypeId override for this engagement. OPTIONAL -- only use if you know the internal value of the engagement type as it will override the engagementType object args.","uniqueKey":"engagementTypeId.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementTypeId","typeLabel":"string | null"},"engagementType":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","description":"The name of the engagementType","isRequired":true,"uniqueKey":"engagementType.oneOf.0.name","typeLabel":"string"},"activityType":{"type":"string","enum":["MEETING","CALL","APPOINTMENT","EMAIL","TEXT","EVENT","SIRO_EVENT","SIRO_BOT_RECORDING"],"description":"Type of activity. Note: SIRO will only consider certain types as \"Appointments\" for our appointment flows: [MEETING, EVENT, APPOINTMENT]","isRequired":true,"uniqueKey":"engagementType.oneOf.0.activityType","typeLabel":"enum\u003cstring>"},"externalId":{"type":"string","description":"The ID of the engagement type in the external system (if applicable)","uniqueKey":"engagementType.oneOf.0.externalId","typeLabel":"string"}},"required":["name","activityType"],"description":"The type of this engagement","uniqueKey":"engagementType.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the engagement type in the external system (if applicable)"},"name":{"type":"string","description":"The name of the engagementType"},"activityType":{"type":"string","enum":["MEETING","CALL","APPOINTMENT","EMAIL","TEXT","EVENT","SIRO_EVENT","SIRO_BOT_RECORDING"],"description":"Type of activity. Note: SIRO will only consider certain types as \"Appointments\" for our appointment flows: [MEETING, EVENT, APPOINTMENT]"}},"required":["name","activityType"],"description":"The type of this engagement","uniqueKey":"engagementType.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementType","typeLabel":"object | null"},"account":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system.","uniqueKey":"account.oneOf.0.externalId","typeLabel":"string"},"name":{"type":"string","description":"The name of the account","uniqueKey":"account.oneOf.0.name","typeLabel":"string"},"latitude":{"type":"number","description":"The latitude of the account","uniqueKey":"account.oneOf.0.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"The longitude of the account","uniqueKey":"account.oneOf.0.longitude","typeLabel":"number"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"account.oneOf.0.addresses.items.[INDEX].country","typeLabel":"string"},"street":{"type":"string","isRequired":true,"uniqueKey":"account.oneOf.0.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"account.oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"account.oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","isRequired":true,"uniqueKey":"account.oneOf.0.addresses.items.[INDEX].zip","typeLabel":"string"}},"required":["country","street","city","state","zip"],"uniqueKey":"account.oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"description":"The address(es) associated to the account","uniqueKey":"account.oneOf.0.addresses","typeLabel":"object[]"},"phoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"account.oneOf.0.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"The phone number(s) for the account","uniqueKey":"account.oneOf.0.phoneNumbers","typeLabel":"string[]"},"emailAddresses":{"type":"array","items":{"type":"string","uniqueKey":"account.oneOf.0.emailAddresses.items.[INDEX]","typeLabel":"string"},"description":"The email address(es) for the account","uniqueKey":"account.oneOf.0.emailAddresses","typeLabel":"string[]"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system","uniqueKey":"account.oneOf.0.lastActivityAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"account.oneOf.0.deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"account.oneOf.0.deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"account.oneOf.0.deletedAt","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","isRequired":true,"uniqueKey":"account.oneOf.0.owner.oneOf.0.externalId","typeLabel":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)","uniqueKey":"account.oneOf.0.owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)","uniqueKey":"account.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"account.oneOf.0.owner","typeLabel":"object | null"},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account.","uniqueKey":"account.oneOf.0.mergedToExternalId","typeLabel":"string"},"mergedFromExternalIds":{"type":"array","items":{"type":"string","uniqueKey":"account.oneOf.0.mergedFromExternalIds.items.[INDEX]","typeLabel":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account.","uniqueKey":"account.oneOf.0.mergedFromExternalIds","typeLabel":"string[]"}},"description":"The associated account for this engagement. Note: supplying just an externalId will resolve to an already-synced account","uniqueKey":"account.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this engagement. Note: supplying just an externalId will resolve to an already-synced account","uniqueKey":"account.oneOf.1","typeLabel":"null"}],"uniqueKey":"account","typeLabel":"object | null"},"engagementUsers":{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string","description":"The user's externalId in the external system","isRequired":true,"uniqueKey":"engagementUsers.items.[INDEX].externalId","typeLabel":"string"},"email":{"type":"string","description":"The user's email, preferably their email in Siro","uniqueKey":"engagementUsers.items.[INDEX].email","typeLabel":"string"},"shareOfSale":{"type":"number","description":"The user's fractional share of the sale, e.g. 0.5 for 50% or 1 for 100% (Optional)","uniqueKey":"engagementUsers.items.[INDEX].shareOfSale","typeLabel":"number"},"name":{"type":"string","description":"The name of the user, e.g. John Smith","uniqueKey":"engagementUsers.items.[INDEX].name","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system (Optional)","uniqueKey":"engagementUsers.items.[INDEX].deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system (Optional)","uniqueKey":"engagementUsers.items.[INDEX].deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementUsers.items.[INDEX].deletedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["externalId"],"uniqueKey":"engagementUsers.items.[INDEX]","typeLabel":"object"},"description":"The users associated with this engagement","uniqueKey":"engagementUsers","typeLabel":"object[]"},"opportunity":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the opportunity in the external system","isRequired":true,"uniqueKey":"opportunity.oneOf.0.externalId","typeLabel":"string"},"name":{"type":"string","description":"The name of the opportunity","uniqueKey":"opportunity.oneOf.0.name","typeLabel":"string"},"amount":{"type":"number","description":"The dollar amount of the opportunity","uniqueKey":"opportunity.oneOf.0.amount","typeLabel":"number"},"closedAt":{"type":"string","description":"The closure date of the opportunity","uniqueKey":"opportunity.oneOf.0.closedAt","typeLabel":"string"},"remoteCreatedAt":{"type":"string","description":"The datetime the opportunity was created in the external system","uniqueKey":"opportunity.oneOf.0.remoteCreatedAt","typeLabel":"string"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this opportunity","uniqueKey":"opportunity.oneOf.0.lastActivityAt","typeLabel":"string"},"disposition":{"type":"string","enum":["OPEN","LOST","WON"],"description":"The disposition of the opportunity (WON, LOST, or OPEN)","uniqueKey":"opportunity.oneOf.0.disposition","typeLabel":"enum\u003cstring>"},"copyEngagementRelationships":{"type":"boolean","description":"When true, copies the available engagement relationships (contact, account, users)","uniqueKey":"opportunity.oneOf.0.copyEngagementRelationships","typeLabel":"boolean"},"opportunityStage":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the stage in the external system. Platforms whose opportunities reference a stage by name rather than by ID (e.g. Salesforce, where Opportunity.StageName holds the name) should send that name here.","isRequired":true,"uniqueKey":"opportunity.oneOf.0.opportunityStage.oneOf.0.externalId","typeLabel":"string"},"name":{"type":"string","description":"The display name of the stage. Optional: platforms that only carry a stage ID on the record can omit it and let the schema sync fill it in.","uniqueKey":"opportunity.oneOf.0.opportunityStage.oneOf.0.name","typeLabel":"string"}},"required":["externalId"],"description":"The pipeline stage of this opportunity. Note: supplying just an externalId will resolve to an already-synced stage","uniqueKey":"opportunity.oneOf.0.opportunityStage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the stage in the external system. Platforms whose opportunities reference a stage by name rather than by ID (e.g. Salesforce, where Opportunity.StageName holds the name) should send that name here."},"name":{"type":"string","description":"The display name of the stage. Optional: platforms that only carry a stage ID on the record can omit it and let the schema sync fill it in."}},"required":["externalId"],"description":"The pipeline stage of this opportunity. Note: supplying just an externalId will resolve to an already-synced stage","uniqueKey":"opportunity.oneOf.0.opportunityStage.oneOf.1","typeLabel":"null"}],"uniqueKey":"opportunity.oneOf.0.opportunityStage","typeLabel":"object | null"}},"required":["externalId"],"description":"The associated opportunity for this engagement. Note: supplying just an externalId will resolve to an already-synced opportunity","uniqueKey":"opportunity.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the opportunity in the external system"},"name":{"type":"string","description":"The name of the opportunity"},"amount":{"type":"number","description":"The dollar amount of the opportunity"},"closedAt":{"type":"string","description":"The closure date of the opportunity"},"remoteCreatedAt":{"type":"string","description":"The datetime the opportunity was created in the external system"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this opportunity"},"disposition":{"type":"string","enum":["OPEN","LOST","WON"],"description":"The disposition of the opportunity (WON, LOST, or OPEN)"},"copyEngagementRelationships":{"type":"boolean","description":"When true, copies the available engagement relationships (contact, account, users)"},"opportunityStage":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the stage in the external system. Platforms whose opportunities reference a stage by name rather than by ID (e.g. Salesforce, where Opportunity.StageName holds the name) should send that name here."},"name":{"type":"string","description":"The display name of the stage. Optional: platforms that only carry a stage ID on the record can omit it and let the schema sync fill it in."}},"required":["externalId"],"description":"The pipeline stage of this opportunity. Note: supplying just an externalId will resolve to an already-synced stage"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the stage in the external system. Platforms whose opportunities reference a stage by name rather than by ID (e.g. Salesforce, where Opportunity.StageName holds the name) should send that name here."},"name":{"type":"string","description":"The display name of the stage. Optional: platforms that only carry a stage ID on the record can omit it and let the schema sync fill it in."}},"required":["externalId"],"description":"The pipeline stage of this opportunity. Note: supplying just an externalId will resolve to an already-synced stage"}]}},"required":["externalId"],"description":"The associated opportunity for this engagement. Note: supplying just an externalId will resolve to an already-synced opportunity","uniqueKey":"opportunity.oneOf.1","typeLabel":"null"}],"uniqueKey":"opportunity","typeLabel":"object | null"},"lead":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the lead in the external system","isRequired":true,"uniqueKey":"lead.oneOf.0.externalId","typeLabel":"string"},"firstName":{"type":"string","description":"The first name of the lead","uniqueKey":"lead.oneOf.0.firstName","typeLabel":"string"},"lastName":{"type":"string","description":"The last name of the lead","uniqueKey":"lead.oneOf.0.lastName","typeLabel":"string"},"latitude":{"type":"number","description":"The latitude of the lead","uniqueKey":"lead.oneOf.0.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"The longitude of the lead","uniqueKey":"lead.oneOf.0.longitude","typeLabel":"number"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"lead.oneOf.0.addresses.items.[INDEX].country","typeLabel":"string"},"street":{"type":"string","isRequired":true,"uniqueKey":"lead.oneOf.0.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"lead.oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"lead.oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","isRequired":true,"uniqueKey":"lead.oneOf.0.addresses.items.[INDEX].zip","typeLabel":"string"}},"required":["country","street","city","state","zip"],"uniqueKey":"lead.oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"description":"The address(es) associated with this lead","uniqueKey":"lead.oneOf.0.addresses","typeLabel":"object[]"},"phoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"lead.oneOf.0.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"The phone number(s) associated with this lead","uniqueKey":"lead.oneOf.0.phoneNumbers","typeLabel":"string[]"},"emailAddresses":{"type":"array","items":{"type":"string","uniqueKey":"lead.oneOf.0.emailAddresses.items.[INDEX]","typeLabel":"string"},"description":"The email address(es) associated with this lead","uniqueKey":"lead.oneOf.0.emailAddresses","typeLabel":"string[]"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system","uniqueKey":"lead.oneOf.0.lastActivityAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"lead.oneOf.0.deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"lead.oneOf.0.deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"lead.oneOf.0.deletedAt","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","isRequired":true,"uniqueKey":"lead.oneOf.0.owner.oneOf.0.externalId","typeLabel":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)","uniqueKey":"lead.oneOf.0.owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)","uniqueKey":"lead.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"lead.oneOf.0.owner","typeLabel":"object | null"},"mergedToExternalId":{"type":"string","description":"If this Lead was merged into another, the surviving Lead externalId. Will migrate all existing references from this Lead to the surviving Lead.","uniqueKey":"lead.oneOf.0.mergedToExternalId","typeLabel":"string"},"mergedFromExternalIds":{"type":"array","items":{"type":"string","uniqueKey":"lead.oneOf.0.mergedFromExternalIds.items.[INDEX]","typeLabel":"string"},"description":"If other Leads were merged into this one, their externalIds. Will migrate all existing references from those Leads to this Lead.","uniqueKey":"lead.oneOf.0.mergedFromExternalIds","typeLabel":"string[]"}},"required":["externalId"],"description":"The associated lead for this engagement","uniqueKey":"lead.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the lead in the external system"},"firstName":{"type":"string","description":"The first name of the lead"},"lastName":{"type":"string","description":"The last name of the lead"},"latitude":{"type":"number","description":"The latitude of the lead"},"longitude":{"type":"number","description":"The longitude of the lead"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated with this lead"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) associated with this lead"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) associated with this lead"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Lead was merged into another, the surviving Lead externalId. Will migrate all existing references from this Lead to the surviving Lead."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Leads were merged into this one, their externalIds. Will migrate all existing references from those Leads to this Lead."}},"required":["externalId"],"description":"The associated lead for this engagement","uniqueKey":"lead.oneOf.1","typeLabel":"null"}],"uniqueKey":"lead","typeLabel":"object | null"},"contact":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the contact in the external system","isRequired":true,"uniqueKey":"contact.oneOf.0.externalId","typeLabel":"string"},"name":{"type":"string","description":"The name of the contact","uniqueKey":"contact.oneOf.0.name","typeLabel":"string"},"latitude":{"type":"number","description":"The latitude of the contact","uniqueKey":"contact.oneOf.0.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"The longitude of the contact","uniqueKey":"contact.oneOf.0.longitude","typeLabel":"number"},"account":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system.","uniqueKey":"contact.oneOf.0.account.oneOf.0.externalId","typeLabel":"string"},"name":{"type":"string","description":"The name of the account","uniqueKey":"contact.oneOf.0.account.oneOf.0.name","typeLabel":"string"},"latitude":{"type":"number","description":"The latitude of the account","uniqueKey":"contact.oneOf.0.account.oneOf.0.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"The longitude of the account","uniqueKey":"contact.oneOf.0.account.oneOf.0.longitude","typeLabel":"number"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses.items.[INDEX].country","typeLabel":"string"},"street":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses.items.[INDEX].zip","typeLabel":"string"}},"required":["country","street","city","state","zip"],"uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"description":"The address(es) associated to the account","uniqueKey":"contact.oneOf.0.account.oneOf.0.addresses","typeLabel":"object[]"},"phoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"contact.oneOf.0.account.oneOf.0.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"The phone number(s) for the account","uniqueKey":"contact.oneOf.0.account.oneOf.0.phoneNumbers","typeLabel":"string[]"},"emailAddresses":{"type":"array","items":{"type":"string","uniqueKey":"contact.oneOf.0.account.oneOf.0.emailAddresses.items.[INDEX]","typeLabel":"string"},"description":"The email address(es) for the account","uniqueKey":"contact.oneOf.0.account.oneOf.0.emailAddresses","typeLabel":"string[]"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system","uniqueKey":"contact.oneOf.0.account.oneOf.0.lastActivityAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"contact.oneOf.0.account.oneOf.0.deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"contact.oneOf.0.account.oneOf.0.deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.oneOf.0.account.oneOf.0.deletedAt","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.account.oneOf.0.owner.oneOf.0.externalId","typeLabel":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)","uniqueKey":"contact.oneOf.0.account.oneOf.0.owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)","uniqueKey":"contact.oneOf.0.account.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.oneOf.0.account.oneOf.0.owner","typeLabel":"object | null"},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account.","uniqueKey":"contact.oneOf.0.account.oneOf.0.mergedToExternalId","typeLabel":"string"},"mergedFromExternalIds":{"type":"array","items":{"type":"string","uniqueKey":"contact.oneOf.0.account.oneOf.0.mergedFromExternalIds.items.[INDEX]","typeLabel":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account.","uniqueKey":"contact.oneOf.0.account.oneOf.0.mergedFromExternalIds","typeLabel":"string[]"}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account","uniqueKey":"contact.oneOf.0.account.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account","uniqueKey":"contact.oneOf.0.account.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.oneOf.0.account","typeLabel":"object | null"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.addresses.items.[INDEX].country","typeLabel":"string"},"street":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.addresses.items.[INDEX].zip","typeLabel":"string"}},"required":["country","street","city","state","zip"],"uniqueKey":"contact.oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"description":"The address(es) associated with this contact","uniqueKey":"contact.oneOf.0.addresses","typeLabel":"object[]"},"phoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"contact.oneOf.0.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"The phone number(s) associated with this contact","uniqueKey":"contact.oneOf.0.phoneNumbers","typeLabel":"string[]"},"emailAddresses":{"type":"array","items":{"type":"string","uniqueKey":"contact.oneOf.0.emailAddresses.items.[INDEX]","typeLabel":"string"},"description":"The email address(es) associated with this contact","uniqueKey":"contact.oneOf.0.emailAddresses","typeLabel":"string[]"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system","uniqueKey":"contact.oneOf.0.lastActivityAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"contact.oneOf.0.deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"contact.oneOf.0.deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.oneOf.0.deletedAt","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","isRequired":true,"uniqueKey":"contact.oneOf.0.owner.oneOf.0.externalId","typeLabel":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)","uniqueKey":"contact.oneOf.0.owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)","uniqueKey":"contact.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact.oneOf.0.owner","typeLabel":"object | null"},"mergedToExternalId":{"type":"string","description":"If this Contact was merged into another, the surviving Contact externalId. Will migrate all existing references from this Contact to the surviving Contact.","uniqueKey":"contact.oneOf.0.mergedToExternalId","typeLabel":"string"},"mergedFromExternalIds":{"type":"array","items":{"type":"string","uniqueKey":"contact.oneOf.0.mergedFromExternalIds.items.[INDEX]","typeLabel":"string"},"description":"If other Contacts were merged into this one, their externalIds. Will migrate all existing references from those Contacts to this Contact.","uniqueKey":"contact.oneOf.0.mergedFromExternalIds","typeLabel":"string[]"}},"required":["externalId"],"description":"(DEPRECATED IN FAVOR OF engagementContacts ARRAY) The associated contact for this engagement. Note: supplying just an externalId will resolve to an already-synced contact","uniqueKey":"contact.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the contact in the external system"},"name":{"type":"string","description":"The name of the contact"},"latitude":{"type":"number","description":"The latitude of the contact"},"longitude":{"type":"number","description":"The longitude of the contact"},"account":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account"}]},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated with this contact"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) associated with this contact"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) associated with this contact"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Contact was merged into another, the surviving Contact externalId. Will migrate all existing references from this Contact to the surviving Contact."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Contacts were merged into this one, their externalIds. Will migrate all existing references from those Contacts to this Contact."}},"required":["externalId"],"description":"(DEPRECATED IN FAVOR OF engagementContacts ARRAY) The associated contact for this engagement. Note: supplying just an externalId will resolve to an already-synced contact","uniqueKey":"contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"contact","typeLabel":"object | null"},"engagementContacts":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the contact in the external system","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].externalId","typeLabel":"string"},"name":{"type":"string","description":"The name of the contact","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].name","typeLabel":"string"},"latitude":{"type":"number","description":"The latitude of the contact","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"type":"number","description":"The longitude of the contact","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].longitude","typeLabel":"number"},"account":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system.","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.externalId","typeLabel":"string"},"name":{"type":"string","description":"The name of the account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.name","typeLabel":"string"},"latitude":{"type":"number","description":"The latitude of the account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"The longitude of the account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.longitude","typeLabel":"number"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses.items.[INDEX].country","typeLabel":"string"},"street":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses.items.[INDEX].zip","typeLabel":"string"}},"required":["country","street","city","state","zip"],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"description":"The address(es) associated to the account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.addresses","typeLabel":"object[]"},"phoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"The phone number(s) for the account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.phoneNumbers","typeLabel":"string[]"},"emailAddresses":{"type":"array","items":{"type":"string","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.emailAddresses.items.[INDEX]","typeLabel":"string"},"description":"The email address(es) for the account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.emailAddresses","typeLabel":"string[]"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.lastActivityAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.deletedAt","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.owner.oneOf.0.externalId","typeLabel":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.owner","typeLabel":"object | null"},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account.","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.mergedToExternalId","typeLabel":"string"},"mergedFromExternalIds":{"type":"array","items":{"type":"string","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.mergedFromExternalIds.items.[INDEX]","typeLabel":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account.","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0.mergedFromExternalIds","typeLabel":"string[]"}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].account","typeLabel":"object | null"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses.items.[INDEX].country","typeLabel":"string"},"street":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses.items.[INDEX].street","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses.items.[INDEX].state","typeLabel":"string"},"zip":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses.items.[INDEX].zip","typeLabel":"string"}},"required":["country","street","city","state","zip"],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses.items.[INDEX]","typeLabel":"object"},"description":"The address(es) associated with this contact","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].addresses","typeLabel":"object[]"},"phoneNumbers":{"type":"array","items":{"type":"string","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].phoneNumbers.items.[INDEX]","typeLabel":"string"},"description":"The phone number(s) associated with this contact","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].phoneNumbers","typeLabel":"string[]"},"emailAddresses":{"type":"array","items":{"type":"string","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].emailAddresses.items.[INDEX]","typeLabel":"string"},"description":"The email address(es) associated with this contact","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].emailAddresses","typeLabel":"string[]"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].lastActivityAt","typeLabel":"string"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].deletedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].deletedAt","typeLabel":"string\u003cdate-time> | null"},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","isRequired":true,"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].owner.oneOf.0.externalId","typeLabel":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].owner.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].owner","typeLabel":"object | null"},"mergedToExternalId":{"type":"string","description":"If this Contact was merged into another, the surviving Contact externalId. Will migrate all existing references from this Contact to the surviving Contact.","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].mergedToExternalId","typeLabel":"string"},"mergedFromExternalIds":{"type":"array","items":{"type":"string","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].mergedFromExternalIds.items.[INDEX]","typeLabel":"string"},"description":"If other Contacts were merged into this one, their externalIds. Will migrate all existing references from those Contacts to this Contact.","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].mergedFromExternalIds","typeLabel":"string[]"},"isPrimary":{"type":"boolean","uniqueKey":"engagementContacts.oneOf.0.items.[INDEX].isPrimary","typeLabel":"boolean"}},"required":["externalId"],"uniqueKey":"engagementContacts.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The associated contacts for this engagement. Note: supplying just an externalId will resolve to an already-synced contact","uniqueKey":"engagementContacts.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the contact in the external system"},"name":{"type":"string","description":"The name of the contact"},"latitude":{"type":"number","description":"The latitude of the contact"},"longitude":{"type":"number","description":"The longitude of the contact"},"account":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account"},{"type":"null","properties":{"externalId":{"type":"string","description":"The ID of the account in the external system."},"name":{"type":"string","description":"The name of the account"},"latitude":{"type":"number","description":"The latitude of the account"},"longitude":{"type":"number","description":"The longitude of the account"},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated to the account"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) for the account"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) for the account"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner user of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Account was merged into another, the surviving Account externalId. Will migrate all existing references from this Account to the surviving Account."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Accounts were merged into this one, their externalIds. Will migrate all existing references from those Accounts to this Account."}},"description":"The associated account for this contact. Note: supplying just an externalId will resolve to an already-synced account"}]},"addresses":{"type":"array","items":{"type":"object","properties":{"country":{"type":"string"},"street":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"required":["country","street","city","state","zip"]},"description":"The address(es) associated with this contact"},"phoneNumbers":{"type":"array","items":{"type":"string"},"description":"The phone number(s) associated with this contact"},"emailAddresses":{"type":"array","items":{"type":"string"},"description":"The email address(es) associated with this contact"},"lastActivityAt":{"type":"string","description":"The datetime of the last activity on this record in the external system"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The datetime when this record was deleted in the external system"},{"type":"null","format":"date-time","description":"The datetime when this record was deleted in the external system"}]},"owner":{"oneOf":[{"type":"object","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)"},{"type":"null","properties":{"externalId":{"type":"string"}},"required":["externalId"],"description":"The owner of this record in the external system (optional)"}]},"mergedToExternalId":{"type":"string","description":"If this Contact was merged into another, the surviving Contact externalId. Will migrate all existing references from this Contact to the surviving Contact."},"mergedFromExternalIds":{"type":"array","items":{"type":"string"},"description":"If other Contacts were merged into this one, their externalIds. Will migrate all existing references from those Contacts to this Contact."},"isPrimary":{"type":"boolean"}},"required":["externalId"]},"description":"The associated contacts for this engagement. Note: supplying just an externalId will resolve to an already-synced contact","uniqueKey":"engagementContacts.oneOf.1","typeLabel":"null"}],"uniqueKey":"engagementContacts","typeLabel":"object[] | null"},"remoteData":{"oneOf":[{"type":"object","description":"Platform-specific data with no column of its own, eg. identifiers writeback needs that the Siro links do not name. Prefer an object -- the column is jsonb, and the legacy string form stores a scalar that cannot be queried into. Omit to leave any stored value untouched.","additionalProperties":{"type":"string","uniqueKey":"remoteData.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"remoteData.oneOf.0","typeLabel":"object"},{"type":"string","description":"Platform-specific data with no column of its own, eg. identifiers writeback needs that the Siro links do not name. Prefer an object -- the column is jsonb, and the legacy string form stores a scalar that cannot be queried into. Omit to leave any stored value untouched.","uniqueKey":"remoteData.oneOf.1","typeLabel":"string"}],"uniqueKey":"remoteData","typeLabel":"object | string"}},"required":["externalId"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"externalId":"\u003cstring>","content":"\u003cstring>","subject":"\u003cstring>","status":"\u003cstring>","startTime":"\u003cstring>","startTimeLocalized":"\u003cstring>","endTime":"\u003cstring>","remoteCreatedAt":"\u003cstring>","remoteUpdatedAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","engagementTypeId":"\u003cstring>","engagementType":{"name":"\u003cstring>","externalId":"\u003cstring>"},"account":{"externalId":"\u003cstring>","name":"\u003cstring>","latitude":123,"longitude":123,"addresses":[{"country":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>"}],"phoneNumbers":["\u003cstring>"],"emailAddresses":["\u003cstring>"],"lastActivityAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","owner":{"externalId":"\u003cstring>"},"mergedToExternalId":"\u003cstring>","mergedFromExternalIds":["\u003cstring>"]},"engagementUsers":[{"externalId":"\u003cstring>","email":"\u003cstring>","shareOfSale":123,"name":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z"}],"opportunity":{"externalId":"\u003cstring>","name":"\u003cstring>","amount":123,"closedAt":"\u003cstring>","remoteCreatedAt":"\u003cstring>","lastActivityAt":"\u003cstring>","copyEngagementRelationships":true,"opportunityStage":{"externalId":"\u003cstring>","name":"\u003cstring>"}},"lead":{"externalId":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","latitude":123,"longitude":123,"addresses":[{"country":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>"}],"phoneNumbers":["\u003cstring>"],"emailAddresses":["\u003cstring>"],"lastActivityAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","owner":{"externalId":"\u003cstring>"},"mergedToExternalId":"\u003cstring>","mergedFromExternalIds":["\u003cstring>"]},"contact":{"externalId":"\u003cstring>","name":"\u003cstring>","latitude":123,"longitude":123,"account":{"externalId":"\u003cstring>","name":"\u003cstring>","latitude":123,"longitude":123,"addresses":[{"country":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>"}],"phoneNumbers":["\u003cstring>"],"emailAddresses":["\u003cstring>"],"lastActivityAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","owner":{"externalId":"\u003cstring>"},"mergedToExternalId":"\u003cstring>","mergedFromExternalIds":["\u003cstring>"]},"addresses":[{"country":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>"}],"phoneNumbers":["\u003cstring>"],"emailAddresses":["\u003cstring>"],"lastActivityAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","owner":{"externalId":"\u003cstring>"},"mergedToExternalId":"\u003cstring>","mergedFromExternalIds":["\u003cstring>"]},"engagementContacts":[{"externalId":"\u003cstring>","name":"\u003cstring>","latitude":123,"longitude":123,"account":{"externalId":"\u003cstring>","name":"\u003cstring>","latitude":123,"longitude":123,"addresses":[{"country":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>"}],"phoneNumbers":["\u003cstring>"],"emailAddresses":["\u003cstring>"],"lastActivityAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","owner":{"externalId":"\u003cstring>"},"mergedToExternalId":"\u003cstring>","mergedFromExternalIds":["\u003cstring>"]},"addresses":[{"country":"\u003cstring>","street":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","zip":"\u003cstring>"}],"phoneNumbers":["\u003cstring>"],"emailAddresses":["\u003cstring>"],"lastActivityAt":"\u003cstring>","deletedAt":"2023-11-07T05:31:56Z","owner":{"externalId":"\u003cstring>"},"mergedToExternalId":"\u003cstring>","mergedFromExternalIds":["\u003cstring>"],"isPrimary":true}],"remoteData":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2b672d3c-7723-4c89-8eb4-f237db01d3a8":{"description":"Sync an engagement","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"externalId":{"type":"string","description":"The ID of the engagement in the external system (e.g. Salesforce)","isRequired":true,"uniqueKey":"data.externalId","typeLabel":"string"},"engagementType":{"type":"string","description":"The type of the engagement","isRequired":true,"uniqueKey":"data.engagementType","typeLabel":"string"},"createdAt":{"type":"string","description":"The date the engagement was created","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"The date the engagement was last updated","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string"},"organizationId":{"type":"string","isRequired":true,"uniqueKey":"data.organizationId","typeLabel":"string"},"direction":{"type":"string","description":"\"INBOUND\" | \"OUTBOUND\"","uniqueKey":"data.direction","typeLabel":"string"},"subject":{"type":"string","description":"The subject of the engagement","uniqueKey":"data.subject","typeLabel":"string"},"content":{"type":"string","description":"The content of the engagement","uniqueKey":"data.content","typeLabel":"string"},"status":{"type":"string","description":"The status of the engagement in the external system,","uniqueKey":"data.status","typeLabel":"string"},"startTime":{"type":"string","description":"The start time of the engagement","uniqueKey":"data.startTime","typeLabel":"string"},"startTimeLocalized":{"type":"string","description":"Localized dateTime of the engagement, without timezone info","uniqueKey":"data.startTimeLocalized","typeLabel":"string"},"endTime":{"type":"string","description":"The end time of the engagement","uniqueKey":"data.endTime","typeLabel":"string"},"recordingId":{"type":"string","description":"The ID of the recording associated to the engagement","uniqueKey":"data.recordingId","typeLabel":"string"},"opportunityId":{"type":"string","description":"The ID of the opportunity associated to the engagement","uniqueKey":"data.opportunityId","typeLabel":"string"},"accountId":{"type":"string","uniqueKey":"data.accountId","typeLabel":"string"},"account":{"oneOf":[{},{"type":"null","uniqueKey":"data.account.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.account","typeLabel":"null"},"engagementUsers":{"type":"array","items":{"oneOf":[{},{"type":"null","uniqueKey":"data.engagementUsers.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.engagementUsers.items.[INDEX]","typeLabel":"null"},"uniqueKey":"data.engagementUsers","typeLabel":"null[]"}},"required":["id","externalId","engagementType","createdAt","updatedAt","organizationId"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","externalId":"\u003cstring>","engagementType":"\u003cstring>","createdAt":"\u003cstring>","updatedAt":"\u003cstring>","organizationId":"\u003cstring>","direction":"\u003cstring>","subject":"\u003cstring>","content":"\u003cstring>","status":"\u003cstring>","startTime":"\u003cstring>","startTimeLocalized":"\u003cstring>","endTime":"\u003cstring>","recordingId":"\u003cstring>","opportunityId":"\u003cstring>","accountId":"\u003cstring>","account":"\u003cunknown>","engagementUsers":["\u003cunknown>"]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"70b481ee-eeb7-4965-8076-3b51f48a1c85":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Access token","description":"Client app access token from POST https://auth.siro.ai/oauth2/token, or a legacy organization API token (Person icon → API Tokens). Send `Authorization: Bearer \u003ctoken>`.","x-default":"Bearer \u003caccess-token>","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b599d88f-5634-48d6-8ef5-4cc68579ecc0":{"url":"https://functions.siro.ai/api-externalApi","description":"Siro API external API endpoint"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Access token","description":"Client app access token from POST https://auth.siro.ai/oauth2/token, or a legacy organization API token (Person icon → API Tokens). Send `Authorization: Bearer \u003ctoken>`.","x-default":"Bearer \u003caccess-token>","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Client app access token from POST https://auth.siro.ai/oauth2/token, or a legacy organization API token (Person icon → API Tokens). Send `Authorization: Bearer \u003ctoken>`.","format":"bearer","default":"Bearer \u003caccess-token>","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"specs/openapi-externalApi.json"},"subdomain":"siro-508e7b35","siteName":"Starter Kit","title":"Sync an engagement - Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-23T22:26:54.189Z","originalFileLocation":"api-references/sync-an-engagement.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Sync an engagement\">\u003cmeta data-mint-head name=\"application-name\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Sync an engagement - Starter Kit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sync an engagement\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.siro.ai/api-references/sync-an-engagement\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://siro-508e7b35.mintlify.app/_mintlify/api/og/v2?division=Engagements\u0026amp;title=Sync+an+engagement\u0026amp;description=Sync+an+engagement\u0026amp;theme=9cc068ea8ea66215c73030aa\u0026amp;signature=29a29ba8d041fb14115df1f012ebdd2b4fb4398e81ce11a6c1195ebba13aadb5\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Sync an engagement - Starter Kit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sync an engagement\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://siro-508e7b35.mintlify.app/_mintlify/api/og/v2?division=Engagements\u0026amp;title=Sync+an+engagement\u0026amp;description=Sync+an+engagement\u0026amp;theme=9cc068ea8ea66215c73030aa\u0026amp;signature=29a29ba8d041fb14115df1f012ebdd2b4fb4398e81ce11a6c1195ebba13aadb5\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/siro-508e7b35/81iGUy2cBK4tv9ux/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F2A710\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.siro.ai/api-references/sync-an-engagement\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-references/sync-an-engagement.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.siro.ai/#organization\",\"name\":\"Starter Kit\",\"url\":\"https://docs.siro.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/siro-508e7b35/YTBFBZtqg9vKFzK0/logo/light.svg?fit=max\u0026auto=format\u0026n=YTBFBZtqg9vKFzK0\u0026q=85\u0026s=57a3776ced9577d8a79264b5ca264487\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.siro.ai#website\",\"name\":\"Starter Kit\",\"url\":\"https://docs.siro.ai\",\"publisher\":{\"@id\":\"https://docs.siro.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.siro.ai/api-references/sync-an-engagement#webpage\",\"url\":\"https://docs.siro.ai/api-references/sync-an-engagement\",\"name\":\"Sync an engagement\",\"description\":\"Sync an engagement\",\"dateModified\":\"2026-01-23T22:26:54.189Z\",\"isPartOf\":{\"@id\":\"https://docs.siro.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.siro.ai/api-references/sync-an-engagement#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.siro.ai/api-references/sync-an-engagement#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Org-wide API\",\"item\":\"https://docs.siro.ai/api-references/get-mobile-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Core\",\"item\":\"https://docs.siro.ai/api-references/get-mobile-events\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Engagements\",\"item\":\"https://docs.siro.ai/api-references/get-an-engagement\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Sync an engagement\",\"item\":\"https://docs.siro.ai/api-references/sync-an-engagement\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.siro.ai/api-references/sync-an-engagement#apireference\",\"headline\":\"Sync an engagement\",\"name\":\"Sync an engagement\",\"description\":\"Sync an engagement\",\"url\":\"https://docs.siro.ai/api-references/sync-an-engagement\",\"mainEntityOfPage\":{\"@id\":\"https://docs.siro.ai/api-references/sync-an-engagement#webpage\"},\"dateModified\":\"2026-01-23T22:26:54.189Z\",\"publisher\":{\"@id\":\"https://docs.siro.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.siro.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Starter Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Starter Kit","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/getting-started"}]},{"anchor":"API References","icon":"code","groups":[{"group":"Authentication","pages":[{"title":"Get a client app access token","openapi":"specs/openapi-auth.json post /oauth2/token","href":"/api-references/get-a-client-app-access-token"}]},{"group":"Org-wide API","pages":[{"group":"Core","pages":[{"group":"Mobile Events","pages":[{"openapi":"get /v1/core/mobile-events","title":"Get mobile events for an org","href":"/api-references/get-mobile-events"},{"openapi":"get /v1/core/mobile-events/{id}","title":"Get mobile event by ID","href":"/api-references/get-mobile-events-id"}]},{"group":"OAuth Apps and Tokens","pages":[{"openapi":"get /v1/core/oauth/apps/{clientId}","title":"Get a specific OAuth app","href":"/api-references/get-an-oauth-app"},{"openapi":"get /v1/core/oauth/apps","title":"Get all OAuth apps for an organization","href":"/api-references/get-oauth-apps"},{"openapi":"post /v1/core/oauth/apps","title":"Create a new OAuth application for an organization","href":"/api-references/create-an-oauth-app"},{"openapi":"delete /v1/core/oauth/apps/{clientId}","title":"Delete an OAuth application by id.","href":"/api-references/delete-an-oauth-app"},{"openapi":"get /v1/core/oauth/apps/{clientId}/access-token/{tokenId}","title":"Get a specific OAuth access token by id.","href":"/api-references/get-an-oauth-access-token"},{"openapi":"get /v1/core/oauth/apps/{clientId}/access-token","title":"Get all OAuth access tokens for a given OAuth app.","href":"/api-references/get-oauth-access-tokens"},{"openapi":"post /v1/core/oauth/apps/{clientId}/access-token","title":"Create a new OAuth access token for a given OAuth app.","href":"/api-references/create-an-oauth-access-token"},{"openapi":"delete /v1/core/oauth/apps/{clientId}/access-token/{tokenId}","title":"Revoke an OAuth access token for a given OAuth app. ","href":"/api-references/delete-an-oauth-access-token"}]},{"group":"Org-Scoped Tokens","pages":[{"openapi":"get /v1/core/auth/tokens/{id}","title":"Get a single authentication token by ID","href":"/api-references/get-an-org-scoped-token"},{"openapi":"get /v1/core/auth/tokens","title":"List all tokens for a given org.","href":"/api-references/get-org-scoped-tokens"},{"openapi":"post /v1/core/auth/tokens","title":"Create a new authentication token for an organization.","href":"/api-references/create-an-org-scoped-token"},{"openapi":"delete /v1/core/auth/tokens/{id}","title":"Delete a single authentication token by ID","href":"/api-references/delete-an-org-scoped-token"}]},{"group":"Integration Connections","pages":[{"openapi":"get /v1/core/integrations/connections","title":"Get all integration connections for a single org","href":"/api-references/get-integration-connections"},{"openapi":"get /v1/core/integrations/connections/{id}","title":"Get a single integration connection within a single org","href":"/api-references/get-an-integration-connection"},{"openapi":"post /v1/core/integrations/connections","title":"Create a new integration connection for a given org","href":"/api-references/create-an-integration-connection"},{"openapi":"patch /v1/core/integrations/connections/{id}","title":"Update a single integration connection within a given org","href":"/api-references/update-an-integration-connection"},{"openapi":"delete /v1/core/integrations/connections/{id}","title":"Delete a single integration connection within a single org","href":"/api-references/delete-an-integration-connection"},{"openapi":"put /v1/core/integrations/salesforce","title":"Upsert Salesforce integration authentication details","href":"/api-references/upsert-a-salesforce-integration-connection"}]},{"group":"Organizations","pages":[{"openapi":"post /v1/core/organizations","title":"Create an organization","href":"/api-references/create-organization"},{"openapi":"get /v1/core/organizations","title":null,"href":"/api-references/get-organizations"},{"openapi":"get /v1/core/organizations/{id}","title":"Get an organization by ID","href":"/api-references/get-organization"},{"openapi":"patch /v1/core/organizations/{id}","title":"Update an organization","href":"/api-references/update-organization"}]},{"group":"Recordings","pages":[{"openapi":"specs/openapi-externalApi.json get /v1/core/recordings/{id}","title":"Get recording","href":"/api-references/get-recording"},{"openapi":"specs/openapi-externalApi.json get /v1/core/recordings","title":"Get recordings","href":"/api-references/get-recordings"},{"openapi":"get /v1/core/recordings/{id}/summaries","title":"Get recording summaries","href":"/api-references/get-recording-summaries"}]},{"group":"Teams","pages":[{"openapi":"get /v1/core/organizations/{orgId}/teams","title":"Get all teams for an org","href":"/api-references/get-teams"},{"openapi":"get /v1/core/organizations/{orgId}/teams/{teamId}","title":"Get a single team within a given org","href":"/api-references/get-a-team"},{"openapi":"post /v1/core/organizations/{orgId}/teams","title":"Create a new team for an org","href":"/api-references/create-a-team"},{"openapi":"patch /v1/core/organizations/{orgId}/teams/{teamId}","title":"Update a single team within a single org","href":"/api-references/update-a-team"},{"openapi":"delete /v1/core/organizations/{orgId}/teams/{teamId}","title":"Hard-delete a single team within a single org","href":"/api-references/delete-a-team"}]},{"group":"Users","pages":[{"openapi":"get /v1/core/users","title":"List users","href":"/api-references/get-users"},{"openapi":"post /v1/core/users","title":"Create a user","href":"/api-references/create-user"},{"openapi":"get /v1/core/users/{id}","title":"Get a user by ID","href":"/api-references/get-user"},{"openapi":"put /v1/core/users/{id}","title":null,"href":"/api-references/update-user"}]},{"group":"Accounts","pages":[{"openapi":"delete /v1/integrations/accounts/{id}","title":"Delete an account","href":"/api-references/delete-an-account"},{"openapi":"get /v1/integrations/accounts","title":"Get accounts","href":"/api-references/get-accounts"},{"openapi":"post /v1/integrations/accounts","title":"Create an account","href":"/api-references/create-an-account"}]},{"group":"Opportunities","pages":[{"openapi":"get /v1/integrations/opportunities/{id}","title":"Get an opportunity","href":"/api-references/get-an-opportunity"},{"openapi":"delete /v1/integrations/opportunities/{id}","title":"Delete an opportunity","href":"/api-references/delete-an-opportunity"},{"openapi":"get /v1/integrations/opportunities","title":"Get opportunities","href":"/api-references/get-opportunities"},{"openapi":"get /v1/integrations/opportunity-users/{id}","title":"Get an opportunity user","href":"/api-references/get-an-opportunity-user"},{"openapi":"put /v1/integrations/opportunity-users/{id}","title":"Update an opportunity user","href":"/api-references/update-an-opportunity-user"},{"openapi":"delete /v1/integrations/opportunity-users/{id}","title":"Delete an opportunity user","href":"/api-references/delete-an-opportunity-user"},{"openapi":"get /v1/integrations/opportunity-users","title":"Get opportunity users","href":"/api-references/get-opportunity-users"},{"openapi":"post /v1/integrations/opportunity-users","title":"Create an opportunity user","href":"/api-references/create-an-opportunity-user"},{"openapi":"put /v1/integrations/sync/opportunities","title":"Sync an opportunity","href":"/api-references/sync-an-opportunity"}]},{"group":"Engagements","pages":[{"openapi":"get /v1/integrations/engagements/{id}","title":"Get an engagement","href":"/api-references/get-an-engagement"},{"openapi":"delete /v1/integrations/engagements/{id}","title":"Delete an engagement","href":"/api-references/delete-an-engagement"},{"openapi":"get /v1/integrations/engagements","title":"Get engagements","href":"/api-references/get-engagements"},{"openapi":"get /v1/integrations/engagement-users/{id}","title":"Get an engagement user","href":"/api-references/get-an-engagement-user"},{"openapi":"put /v1/integrations/engagement-users/{id}","title":"Update an engagement user","href":"/api-references/update-an-engagement-user"},{"openapi":"delete /v1/integrations/engagement-users/{id}","title":"Delete an engagement user","href":"/api-references/delete-an-engagement-user"},{"openapi":"get /v1/integrations/engagement-users","title":"Get engagement users","href":"/api-references/get-engagement-users"},{"openapi":"post /v1/integrations/engagement-users","title":"Create an engagement user","description":"Create an engagement user","href":"/api-references/create-an-engagement-user"},{"openapi":"put /v1/integrations/sync/engagements","title":"Sync an engagement","href":"/api-references/sync-an-engagement"}]},{"group":"Conversation Configurations","pages":[{"openapi":"specs/openapi-internalApi.json get /v1/core/conversation-configurations","title":"Get conversation configurations","description":"Retrieves conversation configurations for an organization. Users can only access configurations for their own organization unless they are organization admins.","href":"/api-references/get-conversation-configurations"}]}]},{"group":"Introspection","pages":[{"openapi":"get /v1/core/auth/caller-identity","title":"Get details about your current auth token","href":"/api-references/get-identity"}]},{"group":"Audit logs","pages":[{"openapi":"get /v1/audit/logs","title":null,"href":"/api-references/get-audit-logs"}]}]},{"group":"User-scoped API","pages":[{"group":"Recordings","pages":[{"openapi":"specs/openapi-internalApi.json get /v1/core/recordings","title":"Get recordings","href":"/api-references/get-recordings-list"},{"openapi":"specs/openapi-internalApi.json get /v1/core/recordings/{id}","title":"Get recording by ID","href":"/api-references/get-recording-details"},{"openapi":"specs/openapi-internalApi.json get /v1/core/recordings/{id}/utterances","title":"Get recording utterances","href":"/api-references/get-recording-utterances"},{"title":"Download redacted recording audio (signed URL)","openapi":"specs/openapi-internalApi.json post /v1/core/recordings/{id}/signedUrl","href":"/api-references/post-recording-audio-signed-url"},{"title":"Create or replace CRM link on a recording","openapi":"specs/openapi-internalApi.json put /v1/core/recordings/{id}/link","href":"/api-references/put-recording-crm-link"},{"title":"Remove CRM link from a recording","openapi":"specs/openapi-internalApi.json delete /v1/core/recordings/{id}/link","href":"/api-references/delete-recording-crm-link"}]},{"group":"Scorecards","pages":[{"title":"Scorecard metrics for one recording","href":"/scorecards-metrics-for-recording"},{"openapi":"specs/openapi-internalApi.json get /v1/core/scorecards/scorecard-metrics/available","title":"Get available scorecard metrics","href":"/api-references/get-scorecard-metrics-available"},{"openapi":"specs/openapi-internalApi.json get /v1/core/scorecards/scorecard-metrics/values","title":"Get scorecard metrics values","href":"/api-references/get-scorecard-metrics-values"},{"openapi":"specs/openapi-internalApi.json get /v1/core/scorecards/instances","title":"Get scorecard instances","href":"/api-references/get-scorecard-instances"},{"openapi":"specs/openapi-internalApi.json get /v1/core/scorecards/evaluated-instances/{id}","title":"Get evaluated scorecard instance","href":"/api-references/get-evaluated-scorecard-instance"}]},{"group":"Extractions","pages":[{"openapi":"get /v1/core/entities/extractions/{recordingId}","title":"Get entity extractions for a recording","href":"/api-references/get-extractions"}]},{"group":"Followups","pages":[{"openapi":"specs/openapi-internalApi.json get /v1/core/followups","title":"Get followups","href":"/api-references/get-followups"}]},{"group":"Upload Recordings","pages":[{"openapi":"post /v1/core/recordings/signed-urls","title":"Get a signed URL for uploading a recording","href":"/api-references/post-recordings-signed-urls"},{"openapi":"post /v1/core/recordings/upload","title":"Create a recording from a phone call","href":"/api-references/post-recordings-upload"}]},{"group":"Client apps","pages":[{"openapi":"get /v1/core/m2m-clients/{organizationId}","title":"List API clients","href":"/api-references/get-client-apps"},{"openapi":"post /v1/core/m2m-clients/{organizationId}/org-admin","title":"Create an org-admin API client","href":"/api-references/create-a-client-app"},{"openapi":"post /v1/core/m2m-clients/{organizationId}/{clientId}/rotate-secret","title":"Rotate an API client secret","href":"/api-references/rotate-a-client-app-secret"},{"openapi":"delete /v1/core/m2m-clients/{organizationId}/{clientId}","title":"Revoke an API client","href":"/api-references/revoke-a-client-app"}]}]},{"group":"Webhooks","pages":[{"openapi":"specs/webhooks.json webhook integrations.recordingProcessed","sidebarTitle":"Recording processed","title":"Recording processed","href":"/api-references/webhook-recording-processed"},{"openapi":"specs/webhooks.json webhook integrations.recordingLinked","sidebarTitle":"Recording linked to CRM record","title":"Recording linked","href":"/api-references/webhook-recording-linked"}]}]},{"anchor":"Triggering Recordings","icon":"microphone","pages":[{"title":"Triggering Recordings","href":"/triggering-recordings/overview"}]}]},"title":"Sync an engagement - Starter Kit","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}