CRM API SCHEMA

{ "schemas": { "insertContact": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertContact", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "phone": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoPhone" } }, "email": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoEmail" } }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "linkedin": { "type": "string" }, "jobTitle": { "type": "string" }, "seniorityLevel": { "type": "string" }, "department": { "type": "string" }, "note": { "type": "string" }, "tenantId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "graphReferenceId": { "type": "string" }, "customFields": { "type": "object" } }, "required": [ "name" ], "additionalProperties": false }, "updateContact": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateContact", "type": "object", "minProperties": 2, "properties": { "name": { "type": "string", "minLength": 1 }, "phone": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoPhone" } }, "email": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoEmail" } }, "linkedin": { "type": "string" }, "jobTitle": { "type": "string" }, "seniorityLevel": { "type": "string" }, "department": { "type": "string" }, "note": { "type": "string" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string" }, "graphReferenceId": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "mergeContact": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "mergeContact", "type": "object", "properties": { "sourceId": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "sourceId", "lastUpdatedBy" ], "additionalProperties": false }, "insertOrganization": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertOrganization", "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "address": { "type": "string" }, "phone": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoPhone" } }, "email": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoEmail" } }, "industry": { "type": "string" }, "size": { "type": "string" }, "annualRevenue": { "type": "string" }, "website": { "type": "string" }, "note": { "type": "string" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" } }, "required": [ "name" ], "additionalProperties": false }, "updateOrganization": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateOrganization", "type": "object", "minProperties": 2, "properties": { "name": { "type": "string", "minLength": 1 }, "address": { "type": "string" }, "phone": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoPhone" } }, "email": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactInfoEmail" } }, "industry": { "type": "string" }, "size": { "type": "string" }, "annualRevenue": { "type": "string" }, "website": { "type": "string" }, "note": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "mergeOrganization": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "mergeOrganization", "type": "object", "properties": { "sourceId": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "sourceId", "lastUpdatedBy" ], "additionalProperties": false }, "insertContactsForm": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertContactsForm", "type": "object", "properties": { "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "fields": { "type": "array", "items": { "$ref": "definitions#/definitions/Field" }, "allOf": [ { "contains": { "type": "object", "properties": { "id": { "const": "name" }, "label": { "const": "Name" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "email" }, "label": { "const": "Email" }, "category": { "const": "default" }, "type": { "const": "email_labeled" }, "labelOptions": { "const": [ "Work", "Personal", "Other" ] } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "phone" }, "label": { "const": "Phone" }, "category": { "const": "default" }, "type": { "const": "tel_labeled" }, "labelOptions": { "const": [ "Work", "Mobile", "Home", "Other" ] } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "organizationId" }, "label": { "const": "Organization" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } } ] } }, "required": [ "fields" ], "additionalProperties": false }, "insertOrganizationForm": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertOrganizationForm", "type": "object", "properties": { "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "fields": { "type": "array", "items": { "$ref": "definitions#/definitions/Field" }, "allOf": [ { "contains": { "type": "object", "properties": { "id": { "const": "name" }, "label": { "const": "Name" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "address" }, "label": { "const": "Address" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "email" }, "label": { "const": "Email" }, "category": { "const": "default" }, "type": { "const": "email_labeled" }, "labelOptions": { "const": [ "Work", "Personal", "Other" ] } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "phone" }, "label": { "const": "Phone" }, "category": { "const": "default" }, "type": { "const": "tel_labeled" }, "labelOptions": { "const": [ "Work", "Mobile", "Home", "Other" ] } } } } ] } }, "required": [ "fields" ], "additionalProperties": false }, "insertTag": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertTag", "$ref": "definitions#/definitions/TagOption", "required": [ "label" ] }, "updateTag": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateTag", "$ref": "definitions#/definitions/TagOption" }, "updateBulkTag": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateBulkTag", "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "definitions#/definitions/TagOption" } } }, "additionalProperties": false }, "insertCase": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertCase", "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "organizationId": { "type": "string" }, "contactId": { "type": "string" }, "caseTypeId": { "type": "string" }, "assignee": { "oneOf": [ { "$ref": "definitions#/definitions/User" }, { "type": "null" } ] }, "priority": { "type": "string" }, "expectedDate": { "type": "string", "format": "date" }, "followers": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "participants": { "type": "array", "items": { "$ref": "definitions#/definitions/Participant" } }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" } }, "required": [ "title", "caseTypeId", "tenantId", "creator" ], "additionalProperties": false }, "updateCase": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateCase", "type": "object", "minProperties": 2, "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "organizationId": { "type": "string" }, "contactId": { "type": "string" }, "caseTypeId": { "type": "string" }, "assignee": { "oneOf": [ { "$ref": "definitions#/definitions/User" }, { "type": "null" } ] }, "priority": { "type": "string" }, "expectedDate": { "type": "string", "format": "date" }, "followers": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "participants": { "type": "array", "items": { "$ref": "definitions#/definitions/Participant" } }, "tags": { "type": "array", "items": { "type": "string" } }, "owner": { "$ref": "definitions#/definitions/User" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" }, "customFields": { "type": "object" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "insertCaseType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertCaseType", "type": "object", "properties": { "label": { "type": "string" }, "form": { "type": "array", "items": { "$ref": "definitions#/definitions/Field" }, "allOf": [ { "contains": { "type": "object", "properties": { "id": { "const": "title" }, "label": { "const": "Title" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "contactId" }, "label": { "const": "Contact" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "organizationId" }, "label": { "const": "Organization" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "assignee" }, "label": { "const": "Assignee" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } } ] }, "workflow": { "$ref": "definitions#/definitions/Workflow" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" } }, "required": [ "label", "form", "workflow", "tenantId", "creator" ], "additionalProperties": false }, "updateCaseType": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateCaseType", "type": "object", "minProperties": 2, "properties": { "label": { "type": "string" }, "form": { "type": "array", "items": { "$ref": "definitions#/definitions/Field" }, "allOf": [ { "contains": { "type": "object", "properties": { "id": { "const": "title" }, "label": { "const": "Title" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "contactId" }, "label": { "const": "Contact" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "organizationId" }, "label": { "const": "Organization" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "assignee" }, "label": { "const": "Assignee" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } } ] }, "workflow": { "$ref": "definitions#/definitions/Workflow" }, "owner": { "$ref": "definitions#/definitions/User" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "insertActivity": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertActivity", "type": "object", "properties": { "type": { "type": "string", "enum": [ "agenda", "note", "attachment", "email" ] }, "relatedItemId": { "$ref": "definitions#/definitions/ItemIds" }, "data": { "minProperties": 1 }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" } }, "allOf": [ { "if": { "type": "object", "properties": { "type": { "const": "agenda" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/Agenda" } } } }, { "if": { "type": "object", "properties": { "type": { "const": "note" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/Note" } } } }, { "if": { "type": "object", "properties": { "type": { "const": "attachment" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/Attachment" } } } }, { "if": { "type": "object", "properties": { "type": { "const": "email" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/EmailActivity" } } } } ], "required": [ "type", "relatedItemId", "data" ], "additionalProperties": false }, "updateActivity": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateActivity", "type": "object", "minProperties": 2, "properties": { "type": { "type": "string", "enum": [ "agenda", "note", "attachment", "email" ] }, "relatedItemId": { "$ref": "definitions#/definitions/ItemIds" }, "data": { "minProperties": 1 }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "allOf": [ { "if": { "type": "object", "properties": { "type": { "const": "agenda" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/Agenda" } } } }, { "if": { "type": "object", "properties": { "type": { "const": "note" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/Note" } } } }, { "if": { "type": "object", "properties": { "type": { "const": "attachment" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/Attachment" } } } }, { "if": { "type": "object", "properties": { "type": { "const": "email" } } }, "then": { "type": "object", "properties": { "data": { "$ref": "definitions#/definitions/EmailActivity" } } } } ], "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "insertLeadForm": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertLeadForm", "type": "object", "properties": { "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "fields": { "type": "array", "items": { "$ref": "definitions#/definitions/Field" }, "allOf": [ { "contains": { "type": "object", "properties": { "id": { "const": "title" }, "label": { "const": "Title" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "value" }, "label": { "const": "Estimated Value" }, "category": { "const": "default" }, "type": { "const": "monetary" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "organizationId" }, "label": { "const": "Organization" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "contactId" }, "label": { "const": "Contact" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } } ] } }, "required": [ "fields" ], "additionalProperties": false }, "insertOpportunityForm": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertOpportunityForm", "type": "object", "properties": { "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "fields": { "type": "array", "items": { "$ref": "definitions#/definitions/Field" }, "allOf": [ { "contains": { "type": "object", "properties": { "id": { "const": "title" }, "label": { "const": "Title" }, "category": { "const": "default" }, "type": { "const": "text" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "value" }, "label": { "const": "Estimated Value" }, "category": { "const": "default" }, "type": { "const": "monetary" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "organizationId" }, "label": { "const": "Organization" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } }, { "contains": { "type": "object", "properties": { "id": { "const": "contactId" }, "label": { "const": "Contact" }, "category": { "const": "default" }, "type": { "const": "combobox" } } } } ] } }, "required": [ "fields" ], "additionalProperties": false }, "insertLead": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertLead", "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "value": { "$ref": "definitions#/definitions/Value" }, "origin": { "type": "string" }, "leadRating": { "type": "string" }, "note": { "type": "string" }, "isArchived": { "type": "boolean" }, "isConverted": { "type": "boolean" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "organizationId": { "type": "string" }, "contactId": { "type": "string" }, "followers": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "participants": { "type": "array", "items": { "$ref": "definitions#/definitions/Participant" } }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" } }, "required": [ "title", "value" ], "anyOf": [ { "required": [ "organizationId" ] }, { "required": [ "contactId" ] } ], "additionalProperties": false }, "updateLead": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateLead", "type": "object", "minProperties": 2, "properties": { "title": { "type": "string", "minLength": 1 }, "value": { "$ref": "definitions#/definitions/Value" }, "origin": { "type": "string" }, "leadRating": { "type": "string" }, "note": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "isArchived": { "type": "boolean" }, "isConverted": { "type": "boolean" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "organizationId": { "type": "string" }, "contactId": { "type": "string" }, "followers": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "participants": { "type": "array", "items": { "$ref": "definitions#/definitions/Participant" } }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "mergeLead": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "mergeLead", "type": "object", "properties": { "sourceId": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "sourceId", "lastUpdatedBy" ], "additionalProperties": false }, "insertOpportunity": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertOpportunity", "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "value": { "$ref": "definitions#/definitions/Value" }, "isArchived": { "type": "boolean" }, "isConverted": { "type": "boolean" }, "stage": { "type": "string" }, "pipelineId": { "type": "string", "format": "uuid" }, "origin": { "type": "string" }, "leadRating": { "type": "string" }, "note": { "type": "string" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "organizationId": { "type": "string" }, "contactId": { "type": "string" }, "leadsId": { "type": "string" }, "followers": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "participants": { "type": "array", "items": { "$ref": "definitions#/definitions/Participant" } }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" } }, "required": [ "title", "value", "pipelineId" ], "anyOf": [ { "required": [ "organizationId" ] }, { "required": [ "contactId" ] } ], "additionalProperties": false }, "updateOpportunity": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateOpportunity", "type": "object", "minProperties": 2, "properties": { "title": { "type": "string", "minLength": 1 }, "value": { "$ref": "definitions#/definitions/Value" }, "isArchived": { "type": "boolean" }, "isConverted": { "type": "boolean" }, "stage": { "type": "string" }, "pipelineId": { "type": "string", "format": "uuid" }, "origin": { "type": "string" }, "leadRating": { "type": "string" }, "note": { "type": "string" }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "organizationId": { "type": "string" }, "contactId": { "type": "string" }, "followers": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "tags": { "type": "array", "items": { "type": "string" } }, "participants": { "type": "array", "items": { "$ref": "definitions#/definitions/Participant" } }, "tenantId": { "type": "string", "format": "uuid" }, "customFields": { "type": "object" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "updateOpportunityStatus": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateOpportunityStatus", "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "won", "lost" ] }, "lostReason": { "type": "object", "properties": { "reasonId": { "type": "string" }, "comment": { "type": "string" } } }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "status", "lastUpdatedBy" ], "additionalProperties": false }, "updateOpportunityStage": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateOpportunityStage", "type": "object", "properties": { "stage": { "type": "string" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "stage", "lastUpdatedBy" ], "additionalProperties": false }, "mergeOpportunity": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "mergeOpportunity", "type": "object", "properties": { "sourceId": { "type": "array", "minItems": 1, "items": { "type": "string" } }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "sourceId", "lastUpdatedBy" ], "additionalProperties": false }, "insertPipeline": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertPipeline", "type": "object", "properties": { "label": { "type": "string", "minLength": 1 }, "stage": { "type": "array", "minItems": 1, "items": { "$ref": "definitions#/definitions/Stage" } }, "owner": { "$ref": "definitions#/definitions/User" }, "creator": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" } }, "required": [ "label", "stage" ], "additionalProperties": false }, "updatePipeline": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updatePipeline", "type": "object", "minProperties": 2, "properties": { "label": { "type": "string", "minLength": 1 }, "stage": { "type": "array", "minItems": 1, "items": { "$ref": "definitions#/definitions/Stage" } }, "stageUpdates": { "type": "array", "minItems": 1, "items": { "$ref": "definitions#/definitions/StageUpdate" } }, "owner": { "$ref": "definitions#/definitions/User" }, "tenantId": { "type": "string", "format": "uuid" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "insertUser": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertUser", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "tenantId": { "type": "string", "format": "uuid" }, "creator": { "$ref": "definitions#/definitions/User" } }, "required": [ "id", "name", "email", "creator" ], "additionalProperties": false }, "updateUser": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateUser", "type": "object", "minProperties": 2, "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "insertUserSetting": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertUserSetting", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "appId": { "type": "string", "format": "uuid" }, "tenantId": { "type": "string", "format": "uuid" }, "displayName": { "type": "string" }, "timezone": { "$ref": "definitions#/definitions/Timezone" }, "settings": { "type": "object", "properties": { "contact": { "$ref": "definitions#/definitions/ContactSettings" }, "organization": { "$ref": "definitions#/definitions/OrganizationSettings" }, "opportunity": { "$ref": "definitions#/definitions/OpportunitySettings" }, "lead": { "$ref": "definitions#/definitions/LeadSettings" }, "case": { "$ref": "definitions#/definitions/CaseSettings" } }, "additionalProperties": false }, "creator": { "$ref": "definitions#/definitions/User" }, "lang": { "type": "string" } }, "required": [ "id", "appId", "tenantId", "settings" ], "additionalProperties": false }, "updateUserSetting": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateUserSetting", "type": "object", "properties": { "displayName": { "type": "string" }, "timezone": { "$ref": "definitions#/definitions/Timezone" }, "settings": { "type": "object", "properties": { "contact": { "$ref": "definitions#/definitions/ContactSettings" }, "organization": { "$ref": "definitions#/definitions/OrganizationSettings" }, "opportunity": { "$ref": "definitions#/definitions/OpportunitySettings" }, "lead": { "$ref": "definitions#/definitions/LeadSettings" }, "case": { "$ref": "definitions#/definitions/CaseSettings" }, "caseType": { "$ref": "definitions#/definitions/CaseTypeSettings" } }, "additionalProperties": false }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" }, "lang": { "type": "string" }, "seenWizard": { "type": "array", "items": { "type": "string", "enum": [ "opportunity" ] } } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "insertAppSetting": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertAppSetting", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "appId": { "type": "string", "format": "uuid" }, "emailSync": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "definitions#/definitions/EmailSyncAccount" } } } }, "contactSync": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactSyncAccount" } } } }, "calendarSync": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "definitions#/definitions/CalendarSyncAccount" } } } }, "users": { "type": "object", "properties": { "owners": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "members": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } } } }, "opportunityLostReasons": { "type": "array", "items": { "$ref": "definitions#/definitions/LostReason" } }, "creator": { "$ref": "definitions#/definitions/User" }, "defaultCurrency": { "$ref": "definitions#/definitions/CurrencyObjectType" } }, "required": [ "id", "appId", "creator" ], "additionalProperties": true }, "updateAppSetting": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateAppSetting", "type": "object", "properties": { "emailSync": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "definitions#/definitions/EmailSyncAccount" } } } }, "contactSync": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "definitions#/definitions/ContactSyncAccount" } } } }, "calendarSync": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "definitions#/definitions/CalendarSyncAccount" } } } }, "users": { "type": "object", "properties": { "owners": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } }, "members": { "type": "array", "items": { "$ref": "definitions#/definitions/User" } } } }, "opportunityLostReasons": { "type": "array", "items": { "$ref": "definitions#/definitions/LostReason" } }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" }, "defaultCurrency": { "$ref": "definitions#/definitions/CurrencyObjectType" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": true }, "addEmailSyncAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "addEmailSyncAccount", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string", "format": "email" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused" ] }, "default": { "type": "boolean" }, "mailFolders": { "type": "object", "properties": { "inbox": { "type": "string" }, "sentItems": { "type": "string" } } }, "account": { "$ref": "definitions#/definitions/Account" } }, "required": [ "expirationDateTime", "creator", "resource", "status", "account" ], "additionalProperties": false }, "updateEmailSyncAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateEmailSyncAccount", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "account": { "$ref": "definitions#/definitions/Account" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused" ] }, "mailFolders": { "type": "object", "properties": { "inbox": { "type": "string" }, "sentItems": { "type": "string" } } }, "default": { "type": "boolean" } }, "additionalProperties": false }, "addContactSyncAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "addContactSyncAccount", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string", "format": "email" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "contactFolder": { "$ref": "definitions#/definitions/ContactFolder" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused", "In-Progress", "Failed" ] }, "type": { "type": "string", "enum": [ "One-Way", "Two-Way" ] }, "account": { "$ref": "definitions#/definitions/Account" }, "initialSyncStatusUrl": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "expirationDateTime", "creator", "resource", "status", "type", "account" ], "additionalProperties": false }, "updateContactSyncAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateContactSyncAccount", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "account": { "$ref": "definitions#/definitions/Account" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "contactFolder": { "$ref": "definitions#/definitions/ContactFolder" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused", "In-Progress", "Failed" ] }, "type": { "type": "string", "enum": [ "One-Way", "Two-Way" ] }, "initialSyncStatusUrl": { "type": "string" }, "default": { "type": "boolean" } }, "additionalProperties": false }, "addCalendarSyncAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "addCalendarSyncAccount", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "emailAddress": { "type": "string", "format": "email" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused" ] }, "account": { "$ref": "definitions#/definitions/Account" }, "default": { "type": "boolean" } }, "required": [ "expirationDateTime", "creator", "resource", "status", "account" ], "additionalProperties": false }, "updateCalendarSyncAccount": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateCalendarSyncAccount", "type": "object", "properties": { "subscriptionId": { "type": "string", "format": "uuid" }, "account": { "$ref": "definitions#/definitions/Account" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused" ] }, "default": { "type": "boolean" } }, "additionalProperties": false }, "insertFilter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "insertFilter", "type": "object", "properties": { "label": { "type": "string" }, "creator": { "$ref": "definitions#/definitions/User" }, "caseTypeId": { "type": "string" }, "tenantId": { "type": "string", "format": "uuid" }, "visibility": { "type": "string", "enum": [ "Public", "Private" ] }, "conditions": { "$ref": "definitions#/definitions/FilterCondition" } }, "required": [ "label", "creator", "tenantId" ], "additionalProperties": false }, "updateFilter": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateFilter", "type": "object", "properties": { "label": { "type": "string" }, "caseTypeId": { "type": "string" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" }, "visibility": { "type": "string", "enum": [ "Public", "Private" ] }, "conditions": { "$ref": "definitions#/definitions/FilterCondition" } }, "required": [ "lastUpdatedBy" ], "additionalProperties": false }, "bulkAction": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "bulkAction", "type": "object", "properties": { "entity": { "type": "string", "enum": [ "contact", "organization", "opportunity", "lead", "case" ] }, "action": { "type": "string", "enum": [ "delete" ] }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "entity", "action", "ids" ], "additionalProperties": false }, "addEmailTemplates": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "addEmailTemplates", "$ref": "definitions#/definitions/EmailTemplate", "required": [ "label", "creator", "tenantId" ] }, "updateEmailTemplates": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "updateEmailTemplates", "$ref": "definitions#/definitions/EmailTemplate", "required": [ "lastUpdatedBy" ] } }, "definitions": { "$id": "definitions", "definitions": { "User": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" } }, "required": [ "id", "name", "email" ], "additionalProperties": false }, "Account": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string", "format": "email" }, "tenantId": { "type": "string" } }, "required": [ "id", "name", "email", "tenantId" ], "additionalProperties": false }, "Participant": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false }, "ItemIds": { "type": "object", "properties": { "contactId": { "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "array", "items": { "type": "string" } }, "caseId": { "type": "array", "items": { "type": "string" } }, "leadId": { "type": "array", "items": { "type": "string" } }, "opportunityId": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "DateTimeTimeZone": { "type": "object", "properties": { "dateTime": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } } }, "Agenda": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "done" ] }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "call", "meeting", "email", "lunch", "task", "deadline", "message" ] }, "time": { "type": "object", "properties": { "start": { "$ref": "definitions#/definitions/AgendaDateTime" }, "end": { "$ref": "definitions#/definitions/AgendaDateTime" }, "isAllDay": { "type": "boolean" } } }, "location": { "type": "string" }, "description": { "type": "string" }, "ownerAvailability": { "type": "string" }, "note": { "type": "string" }, "owner": { "$ref": "definitions#/definitions/User" }, "relatedItemId": { "type": "string" }, "contactId": { "type": [ "string", "null" ] }, "organizationId": { "type": [ "string", "null" ] }, "guestIds": { "type": "array", "items": { "type": "string" } }, "createdBy": { "$ref": "definitions#/definitions/User" }, "lastUpdateBy": { "$ref": "definitions#/definitions/User" } }, "required": [ "title", "type", "ownerAvailability" ] }, "AgendaDateTime": { "type": "object", "properties": { "dateTime": { "type": "string", "format": "date-time" }, "timeZone": { "type": "string" } } }, "Note": { "type": "object", "properties": { "notes": { "type": "string" } }, "additionalProperties": false }, "Attachment": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "number" }, "url": { "type": "string" }, "caption": { "type": "string" } }, "additionalProperties": false }, "EmailActivity": { "type": "object", "properties": { "bccRecipients": { "type": "array", "items": { "$ref": "definitions#/definitions/EmailGraph" } }, "body": { "$ref": "definitions#/definitions/MessageBody" }, "bodyPreview": { "type": "string" }, "ccRecipients": { "type": "array", "items": { "$ref": "definitions#/definitions/EmailGraph" } }, "conversationId": { "type": "string" }, "conversationIndex": { "type": "string" }, "createdDateTime": { "type": "string" }, "from": { "$ref": "definitions#/definitions/EmailGraph" }, "hasAttachments": { "type": "boolean" }, "id": { "type": "string" }, "receivedDateTime": { "type": "string" }, "replyTo": { "type": "array", "items": { "$ref": "definitions#/definitions/EmailGraph" } }, "sender": { "$ref": "definitions#/definitions/EmailGraph" }, "sentDateTime": { "type": "string" }, "subject": { "type": "string" }, "toRecipients": { "type": "array", "items": { "$ref": "definitions#/definitions/EmailGraph" } }, "mailFolders": { "type": "string", "enum": [ "inbox", "sentItems" ] }, "attachments": { "type": "array", "items": { "type": "object" } } } }, "EmailGraph": { "type": "object", "properties": { "emailAddress": { "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" } } } } }, "MessageBody": { "type": "object", "properties": { "contentType": { "type": "string" }, "content": { "type": "string" } } }, "ContactInfoPhone": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" }, "primary": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false }, "ContactInfoEmail": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string", "format": "email" }, "primary": { "type": "boolean" } }, "required": [ "value" ], "additionalProperties": false }, "Field": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "category": { "type": "string", "enum": [ "default", "custom" ] }, "type": { "type": "string", "enum": [ "tag-picker", "number", "email", "date", "date-range", "datetime-local", "datetime-range", "dropdown", "monetary", "persona", "tags", "tel", "text", "time", "time-range", "url", "combobox", "text_labeled", "number_labeled", "date_labeled", "datetime-local_labeled", "url_labeled", "email_labeled", "time_labeled", "tel_labeled", "text-area", "people-picker" ] }, "required": { "type": "boolean" }, "labelOptions": { "type": "array", "items": { "type": "string" } }, "multivalue": { "type": "boolean" }, "multiSelect": { "type": "boolean" }, "deleted": { "type": "boolean" }, "options": { "type": "array" }, "uiMode": { "type": "string" }, "dataSrc": { "type": "string" }, "dataSrcType": { "type": "string", "enum": [ "fix", "fetch" ] }, "defaultOptions": { "type": "array" } }, "required": [ "id", "label", "category", "type" ], "additionalProperties": false }, "Stage": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "data": { "type": "object" } }, "required": [ "key", "label" ], "additionalProperties": false }, "StageUpdate": { "type": "object", "properties": { "from": { "$ref": "definitions#/definitions/StageInfo" }, "to": { "$ref": "definitions#/definitions/StageInfo" } }, "required": [ "from", "to" ], "additionalProperties": false }, "StageInfo": { "type": "object", "properties": { "pipelineId": { "type": "string" }, "stageId": { "type": "string" } }, "required": [ "pipelineId", "stageId" ], "additionalProperties": false }, "Workflow": { "type": "object", "properties": { "status": { "type": "array", "items": { "$ref": "definitions#/definitions/Status" } }, "transition": { "type": "array", "items": { "$ref": "definitions#/definitions/Transition" } } }, "required": [ "status", "transition" ], "additionalProperties": false }, "Status": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ] }, "data": { "$ref": "definitions#/definitions/StatusData" }, "targetPosition": { "type": "string" }, "sourcePosition": { "type": "string" }, "deletable": { "type": "boolean" }, "selected": { "type": "boolean" }, "positionAbsolute": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ] }, "dragging": { "type": "boolean" } }, "required": [ "id", "type", "position" ], "additionalProperties": false }, "Transition": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "label": { "type": "string" }, "source": { "type": "string" }, "sourceHandle": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "type": "string" }, "targetHandle": { "oneOf": [ { "type": "string" }, { "type": "null" } ] }, "markerEnd": { "$ref": "definitions#/definitions/EdgeMarker" }, "data": { "$ref": "definitions#/definitions/TransitionData" }, "selected": { "type": "boolean" }, "style": { "type": "object", "properties": { "strokeWidth": { "type": "number" }, "stroke": { "type": "string" } }, "additionalProperties": true } }, "required": [ "id", "type", "label" ], "additionalProperties": false }, "EdgeMarker": { "type": "object", "properties": { "type": { "type": "string" }, "color": { "type": "string" }, "width": { "type": "number" }, "height": { "type": "number" }, "strokeWidth": { "type": "number" } }, "required": [ "type" ], "additionalProperties": true }, "StatusData": { "type": "object", "properties": { "label": { "type": "string" }, "recordResolutionSLA": { "type": "boolean" }, "color": { "type": "string" } }, "required": [ "label" ], "additionalProperties": true }, "TransitionData": { "type": "object", "properties": { "iconName": { "type": "string" }, "isEditing": { "type": "boolean" }, "recordComment": { "type": "boolean" }, "authorizedUsers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": true }, "ContactSettings": { "type": "object", "minProperties": 1, "properties": { "table": { "$ref": "definitions#/definitions/TableConfig" }, "pageSize": { "type": "number" } }, "additionalProperties": true }, "OrganizationSettings": { "type": "object", "minProperties": 1, "properties": { "table": { "$ref": "definitions#/definitions/TableConfig" }, "pageSize": { "type": "number" } }, "additionalProperties": true }, "OpportunitySettings": { "type": "object", "minProperties": 1, "properties": { "displayPipelineId": { "type": "string", "format": "uuid" }, "table": { "$ref": "definitions#/definitions/TableConfig" }, "pageSize": { "type": "number" } }, "additionalProperties": true }, "LeadSettings": { "type": "object", "minProperties": 1, "properties": { "table": { "$ref": "definitions#/definitions/TableConfig" }, "pageSize": { "type": "number" } }, "additionalProperties": true }, "CaseSettings": { "type": "object", "minProperties": 1, "properties": { "displayCaseTypeId": { "type": "string" }, "table": { "$ref": "definitions#/definitions/TableConfig" }, "pageSize": { "type": "number" } }, "additionalProperties": { "type": "object", "minProperties": 1, "properties": { "table": { "$ref": "definitions#/definitions/TableConfig" } }, "additionalProperties": true } }, "CaseTypeSettings": { "type": "object", "minProperties": 1, "properties": { "table": { "$ref": "definitions#/definitions/TableConfig" }, "pageSize": { "type": "number" } }, "additionalProperties": true }, "TableConfig": { "type": "object", "properties": { "sort": { "$ref": "definitions#/definitions/TableSorting" }, "columns": { "type": "array", "minItems": 1, "items": { "$ref": "definitions#/definitions/TableColumn" } } }, "required": [ "sort", "columns" ], "additionalProperties": false }, "TableColumn": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "dataIndex": { "type": "string" }, "hidden": { "type": "boolean" }, "width": { "type": "number" } }, "required": [ "id", "label", "hidden", "width" ], "additionalProperties": true }, "TableSorting": { "type": "object", "properties": { "by": { "type": "string" }, "direction": { "$ref": "definitions#/definitions/Sort" } }, "required": [ "by", "direction" ], "additionalProperties": false }, "Sort": { "type": "string", "enum": [ "asc", "desc", "ASC", "DESC" ] }, "Timezone": { "type": "object", "properties": { "offset": { "type": "number" }, "label": { "type": "string" } } }, "Value": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "amount", "code" ], "additionalProperties": false }, "EmailSyncAccount": { "type": "object", "properties": { "subscriptionId": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused" ] }, "default": { "type": "boolean" }, "account": { "$ref": "definitions#/definitions/Account" }, "mailFolders": { "type": "object", "properties": { "inbox": { "type": "string" }, "sentItems": { "type": "string" } } } }, "required": [ "subscriptionId", "account", "expirationDateTime", "resource", "status" ], "additionalProperties": false }, "CalendarSyncAccount": { "type": "object", "properties": { "subscriptionId": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused" ] }, "account": { "$ref": "definitions#/definitions/Account" }, "default": { "type": "boolean" } }, "required": [ "subscriptionId", "account", "expirationDateTime", "resource", "status" ], "additionalProperties": false }, "ContactSyncAccount": { "type": "object", "properties": { "subscriptionId": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "expirationDateTime": { "type": "string", "format": "date-time" }, "creator": { "$ref": "definitions#/definitions/User" }, "resource": { "type": "string" }, "contactFolder": { "$ref": "definitions#/definitions/ContactFolder" }, "status": { "type": "string", "enum": [ "Active", "Inactive", "Paused", "In-Progress", "Failed" ] }, "type": { "type": "string", "enum": [ "One-Way", "Two-Way" ] }, "account": { "$ref": "definitions#/definitions/Account" }, "initialSyncStatusUrl": { "type": "string" }, "default": { "type": "boolean" } }, "required": [ "subscriptionId", "account", "expirationDateTime", "resource", "status", "type" ], "additionalProperties": false }, "ContactFolder": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "parentFolderId": { "type": "string" } }, "required": [ "id", "displayName", "parentFolderId" ], "additionalProperties": false }, "TagOption": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "tenantId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "FilterCondition": { "type": "object", "properties": { "AND": { "type": "array", "items": { "$ref": "definitions#/definitions/Condition" } }, "OR": { "type": "array", "items": { "$ref": "definitions#/definitions/Condition" } } }, "additionalProperties": false }, "Condition": { "type": "object", "properties": { "entity": { "type": "string", "enum": [ "Contact", "Organization", "Lead", "Opportunity", "Case" ] }, "fieldId": { "type": "string" }, "operator": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" }, { "type": "number" } ] } }, "required": [ "entity", "fieldId", "operator", "value" ], "additionalProperties": false }, "LostReason": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false }, "CurrencyObjectType": { "type": "object", "properties": { "name": { "type": "string" }, "symbol": { "type": "string" }, "symbolNative": { "type": "string" }, "decimalDigits": { "type": "number" }, "rounding": { "type": "number" }, "code": { "type": "string" }, "namePlural": { "type": "string" } } }, "EmailTemplate": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "tenantId": { "type": "string" }, "creator": { "$ref": "definitions#/definitions/User" }, "lastUpdatedBy": { "$ref": "definitions#/definitions/User" }, "visibility": { "type": "string", "enum": [ "Private", "Public" ] }, "content": { "type": "string" }, "subject": { "type": "string" } }, "additionalProperties": false } } } }