## conformityAdd **Type:** GraphQL mutations ### Arguments - mainType (String) - mainTypeId (String) - relType (String) - relTypeId (String) ### Response **Type:** Conformity **Description:** undefined #### Fields - _id (String) - mainType (String) - mainTypeId (String) - relType (String) - relTypeId (String) --- ## conformityEdit **Type:** GraphQL mutations ### Arguments - mainType (String) - mainTypeId (String) - relType (String) - relTypeIds (String) ### Response **Type:** SuccessResult **Description:** undefined #### Fields - success (Boolean) --- ## tagsAdd **Type:** GraphQL mutations **Description:** Create a new tag. ### Arguments - name (String) - type (String) - colorCode (String) - parentId (String) ### Response **Type:** Tag **Description:** Tag used for categorizing entities across the system. #### Fields - _id (String) - name (String) - type (String) - colorCode (String) - createdAt (Date) - objectCount (Int) - totalObjectCount (Int) - parentId (String) - order (String) - relatedIds (String) - childTags (Tag) --- ## tagsEdit **Type:** GraphQL mutations **Description:** Edit a tag by id. ### Arguments - _id (String) - name (String) - type (String) - colorCode (String) - parentId (String) ### Response **Type:** Tag **Description:** Tag used for categorizing entities across the system. #### Fields - _id (String) - name (String) - type (String) - colorCode (String) - createdAt (Date) - objectCount (Int) - totalObjectCount (Int) - parentId (String) - order (String) - relatedIds (String) - childTags (Tag) --- ## tagsRemove **Type:** GraphQL mutations **Description:** Remove a tag by id. ### Arguments - _id (String) ### Response **Type:** JSON --- ## tagsTag **Type:** GraphQL mutations **Description:** Attach/detach tags to target entities. ### Arguments - type (String) - targetIds (String) - tagIds (String) ### Response **Type:** String --- ## tagsMerge **Type:** GraphQL mutations **Description:** Merge two tags (source into destination). ### Arguments - sourceId (String) - destId (String) ### Response **Type:** Tag **Description:** Tag used for categorizing entities across the system. #### Fields - _id (String) - name (String) - type (String) - colorCode (String) - createdAt (Date) - objectCount (Int) - totalObjectCount (Int) - parentId (String) - order (String) - relatedIds (String) - childTags (Tag) --- ## formSubmissionsSave **Type:** GraphQL mutations ### Arguments - formId (String) - contentTypeId (String) - contentType (String) - formSubmissions (JSON) ### Response **Type:** Boolean --- ## fieldsAdd **Type:** GraphQL mutations ### Arguments - contentType (String) - contentTypeId (String) - type (String) - validation (String) - regexValidation (String) - text (String) - description (String) - code (String) - options (String) - locationOptions (LocationOptionInput): undefined - lat (Float) - lng (Float) - description (String) - isRequired (Boolean) - order (Int) - groupId (String) - isVisible (Boolean) - canHide (Boolean) - associatedFieldId (String) - logicAction (String) - logics (LogicInput): undefined - fieldId (String) - tempFieldId (String) - logicOperator (String) - logicValue (JSON) - searchable (Boolean) - showInCard (Boolean) - objectListConfigs (objectListConfigInput): undefined - key (String) - label (String) - type (String) - isVisibleToCreate (Boolean) ### Response **Type:** Field **Description:** undefined #### Fields - _id (String) - contentType (String) - contentTypeId (String) - name (String) - isVisible (Boolean) - isVisibleInDetail (Boolean) - canHide (Boolean) - groupId (String) - lastUpdatedUser (User) - lastUpdatedUserId (String) - associatedField (Field) - locationOptions (LocationOption) - objectListConfigs (ObjectListConfig) - optionsValues (String) - subFieldIds (String) - subFields (Field) - products (Product) - logics (Logic) - description (String) - options (String) - type (String) - validation (String) - regexValidation (String) - text (String) - content (String) - isRequired (Boolean) - order (Int) - associatedFieldId (String) - logicAction (String) - column (Int) - pageNumber (Int) - code (String) - searchable (Boolean) - showInCard (Boolean) - isVisibleToCreate (Boolean) - productCategoryId (String) - field (String) - isDefinedByKarzoun (Boolean) --- ## fieldsEdit **Type:** GraphQL mutations ### Arguments - _id (String) - type (String) - validation (String) - regexValidation (String) - text (String) - description (String) - code (String) - options (String) - locationOptions (LocationOptionInput): undefined - lat (Float) - lng (Float) - description (String) - isRequired (Boolean) - order (Int) - groupId (String) - isVisible (Boolean) - canHide (Boolean) - associatedFieldId (String) - logicAction (String) - logics (LogicInput): undefined - fieldId (String) - tempFieldId (String) - logicOperator (String) - logicValue (JSON) - searchable (Boolean) - showInCard (Boolean) - objectListConfigs (objectListConfigInput): undefined - key (String) - label (String) - type (String) - isVisibleToCreate (Boolean) ### Response **Type:** Field **Description:** undefined #### Fields - _id (String) - contentType (String) - contentTypeId (String) - name (String) - isVisible (Boolean) - isVisibleInDetail (Boolean) - canHide (Boolean) - groupId (String) - lastUpdatedUser (User) - lastUpdatedUserId (String) - associatedField (Field) - locationOptions (LocationOption) - objectListConfigs (ObjectListConfig) - optionsValues (String) - subFieldIds (String) - subFields (Field) - products (Product) - logics (Logic) - description (String) - options (String) - type (String) - validation (String) - regexValidation (String) - text (String) - content (String) - isRequired (Boolean) - order (Int) - associatedFieldId (String) - logicAction (String) - column (Int) - pageNumber (Int) - code (String) - searchable (Boolean) - showInCard (Boolean) - isVisibleToCreate (Boolean) - productCategoryId (String) - field (String) - isDefinedByKarzoun (Boolean) --- ## fieldsRemove **Type:** GraphQL mutations ### Arguments - _id (String) ### Response **Type:** Field **Description:** undefined #### Fields - _id (String) - contentType (String) - contentTypeId (String) - name (String) - isVisible (Boolean) - isVisibleInDetail (Boolean) - canHide (Boolean) - groupId (String) - lastUpdatedUser (User) - lastUpdatedUserId (String) - associatedField (Field) - locationOptions (LocationOption) - objectListConfigs (ObjectListConfig) - optionsValues (String) - subFieldIds (String) - subFields (Field) - products (Product) - logics (Logic) - description (String) - options (String) - type (String) - validation (String) - regexValidation (String) - text (String) - content (String) - isRequired (Boolean) - order (Int) - associatedFieldId (String) - logicAction (String) - column (Int) - pageNumber (Int) - code (String) - searchable (Boolean) - showInCard (Boolean) - isVisibleToCreate (Boolean) - productCategoryId (String) - field (String) - isDefinedByKarzoun (Boolean) --- ## fieldsGroupsAdd **Type:** GraphQL mutations ### Arguments - name (String) - contentType (String) - order (Int) - description (String) - parentId (String) - code (String) - isMultiple (Boolean) - isVisible (Boolean) - alwaysOpen (Boolean) - isVisibleInDetail (Boolean) - config (JSON) - logicAction (String) - logics (LogicInput): undefined - fieldId (String) - tempFieldId (String) - logicOperator (String) - logicValue (JSON) ### Response **Type:** FieldsGroup **Description:** undefined #### Fields - _id (String) - name (String) - contentType (String) - order (Int) - code (String) - parentId (String) - description (String) - isMultiple (Boolean) - isVisible (Boolean) - isVisibleInDetail (Boolean) - alwaysOpen (Boolean) - isDefinedByKarzoun (Boolean) - fields (Field) - lastUpdatedUserId (String) - lastUpdatedUser (User) - config (JSON) - logicAction (String) - logics (Logic) --- ## fieldsGroupsEdit **Type:** GraphQL mutations ### Arguments - _id (String) - name (String) - contentType (String) - order (Int) - description (String) - parentId (String) - code (String) - isMultiple (Boolean) - isVisible (Boolean) - alwaysOpen (Boolean) - isVisibleInDetail (Boolean) - config (JSON) - logicAction (String) - logics (LogicInput): undefined - fieldId (String) - tempFieldId (String) - logicOperator (String) - logicValue (JSON) ### Response **Type:** FieldsGroup **Description:** undefined #### Fields - _id (String) - name (String) - contentType (String) - order (Int) - code (String) - parentId (String) - description (String) - isMultiple (Boolean) - isVisible (Boolean) - isVisibleInDetail (Boolean) - alwaysOpen (Boolean) - isDefinedByKarzoun (Boolean) - fields (Field) - lastUpdatedUserId (String) - lastUpdatedUser (User) - config (JSON) - logicAction (String) - logics (Logic) --- ## fieldsGroupsRemove **Type:** GraphQL mutations ### Arguments - _id (String) ### Response **Type:** JSON --- ## companiesAdd **Type:** GraphQL mutations **Description:** Create a new company record with core contact, address, and classification fields. ### Arguments - avatar (String) - primaryName (String) - names (String) - primaryPhone (String) - phones (String) - primaryEmail (String) - emails (String) - primaryAddress (JSON) - addresses (JSON) - size (Int) - website (String) - industry (String) - parentCompanyId (String) - email (String) - ownerId (String) - businessType (String) - description (String) - isSubscribed (String) - links (JSON) - tagIds (String) - customFieldsData (JSON) - code (String) - location (String) ### Response **Type:** Company **Description:** Company (account) entity that aggregates contacts, contact details, and CRM metadata. #### Fields - createdAt (Date) - modifiedAt (Date) - avatar (String) - size (Int) - website (String) - industry (String) - plan (String) - parentCompanyId (String) - ownerId (String) - mergedIds (String) - names (String) - primaryName (String) - emails (String) - primaryEmail (String) - phones (String) - primaryPhone (String) - primaryAddress (JSON) - addresses (JSON) - businessType (String) - description (String) - isSubscribed (String) - links (JSON) - owner (User) - parentCompany (Company) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - customers (Customer) - getTags (Tag) - code (String) - location (String) - score (Float) - _id (String) --- ## companiesEdit **Type:** GraphQL mutations **Description:** Update an existing company by id; supports partial edits of contact and CRM fields. ### Arguments - _id (String) - avatar (String) - primaryName (String) - names (String) - primaryPhone (String) - phones (String) - primaryEmail (String) - emails (String) - primaryAddress (JSON) - addresses (JSON) - size (Int) - website (String) - industry (String) - parentCompanyId (String) - email (String) - ownerId (String) - businessType (String) - description (String) - isSubscribed (String) - links (JSON) - tagIds (String) - customFieldsData (JSON) - code (String) - location (String) ### Response **Type:** Company **Description:** Company (account) entity that aggregates contacts, contact details, and CRM metadata. #### Fields - createdAt (Date) - modifiedAt (Date) - avatar (String) - size (Int) - website (String) - industry (String) - plan (String) - parentCompanyId (String) - ownerId (String) - mergedIds (String) - names (String) - primaryName (String) - emails (String) - primaryEmail (String) - phones (String) - primaryPhone (String) - primaryAddress (JSON) - addresses (JSON) - businessType (String) - description (String) - isSubscribed (String) - links (JSON) - owner (User) - parentCompany (Company) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - customers (Customer) - getTags (Tag) - code (String) - location (String) - score (Float) - _id (String) --- ## companiesEditByField **Type:** GraphQL mutations **Description:** Patch company fields by selector for bulk or conditional updates. ### Arguments - selector (JSON) - doc (JSON) ### Response **Type:** Company **Description:** Company (account) entity that aggregates contacts, contact details, and CRM metadata. #### Fields - createdAt (Date) - modifiedAt (Date) - avatar (String) - size (Int) - website (String) - industry (String) - plan (String) - parentCompanyId (String) - ownerId (String) - mergedIds (String) - names (String) - primaryName (String) - emails (String) - primaryEmail (String) - phones (String) - primaryPhone (String) - primaryAddress (JSON) - addresses (JSON) - businessType (String) - description (String) - isSubscribed (String) - links (JSON) - owner (User) - parentCompany (Company) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - customers (Customer) - getTags (Tag) - code (String) - location (String) - score (Float) - _id (String) --- ## companiesRemove **Type:** GraphQL mutations **Description:** Remove one or more companies; returns removed ids. ### Arguments - companyIds (String) ### Response **Type:** String --- ## companiesMerge **Type:** GraphQL mutations **Description:** Merge multiple companies into a primary record, applying provided field overrides. ### Arguments - companyIds (String) - companyFields (JSON) ### Response **Type:** Company **Description:** Company (account) entity that aggregates contacts, contact details, and CRM metadata. #### Fields - createdAt (Date) - modifiedAt (Date) - avatar (String) - size (Int) - website (String) - industry (String) - plan (String) - parentCompanyId (String) - ownerId (String) - mergedIds (String) - names (String) - primaryName (String) - emails (String) - primaryEmail (String) - phones (String) - primaryPhone (String) - primaryAddress (JSON) - addresses (JSON) - businessType (String) - description (String) - isSubscribed (String) - links (JSON) - owner (User) - parentCompany (Company) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - customers (Customer) - getTags (Tag) - code (String) - location (String) - score (Float) - _id (String) --- ## customersAdd **Type:** GraphQL mutations **Description:** Create a new customer/contact. The optional state can denote lead vs. customer pipelines. ### Arguments - state (String) - avatar (String) - firstName (String) - lastName (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - ownerId (String) - tagIds (String) - leadStatus (String) - description (String) - isSubscribed (String) - links (JSON) - customFieldsData (JSON) - code (String) - sex (Int) - birthDate (Date) - emailValidationStatus (String) - phoneValidationStatus (String) ### Response **Type:** Customer **Description:** Customer/contact entity capturing personal details, subscription status, and engagement metadata. #### Fields - state (String) - createdAt (Date) - modifiedAt (Date) - avatar (String) - integrationId (String) - firstName (String) - lastName (String) - birthDate (Date) - sex (Int) - email (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - phone (String) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - ownerId (String) - leadStatus (String) - leadStageHistory (LeadStageHistoryEntry) - description (String) - isSubscribed (String) - code (String) - emailValidationStatus (String) - phoneValidationStatus (String) - links (JSON) - companies (Company) - getTags (Tag) - integration (Integration) - owner (User) - score (Float) - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only). - _id (String) - conversations (Conversation) --- ## customersEdit **Type:** GraphQL mutations **Description:** Update a customer by id with profile or CRM attributes. ### Arguments - _id (String) - avatar (String) - firstName (String) - lastName (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - ownerId (String) - tagIds (String) - leadStatus (String) - description (String) - isSubscribed (String) - links (JSON) - customFieldsData (JSON) - code (String) - sex (Int) - birthDate (Date) - emailValidationStatus (String) - phoneValidationStatus (String) ### Response **Type:** Customer **Description:** Customer/contact entity capturing personal details, subscription status, and engagement metadata. #### Fields - state (String) - createdAt (Date) - modifiedAt (Date) - avatar (String) - integrationId (String) - firstName (String) - lastName (String) - birthDate (Date) - sex (Int) - email (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - phone (String) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - ownerId (String) - leadStatus (String) - leadStageHistory (LeadStageHistoryEntry) - description (String) - isSubscribed (String) - code (String) - emailValidationStatus (String) - phoneValidationStatus (String) - links (JSON) - companies (Company) - getTags (Tag) - integration (Integration) - owner (User) - score (Float) - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only). - _id (String) - conversations (Conversation) --- ## customersEditByField **Type:** GraphQL mutations **Description:** Patch customer fields by selector for conditional/bulk edits. ### Arguments - selector (JSON) - doc (JSON) ### Response **Type:** Customer **Description:** Customer/contact entity capturing personal details, subscription status, and engagement metadata. #### Fields - state (String) - createdAt (Date) - modifiedAt (Date) - avatar (String) - integrationId (String) - firstName (String) - lastName (String) - birthDate (Date) - sex (Int) - email (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - phone (String) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - ownerId (String) - leadStatus (String) - leadStageHistory (LeadStageHistoryEntry) - description (String) - isSubscribed (String) - code (String) - emailValidationStatus (String) - phoneValidationStatus (String) - links (JSON) - companies (Company) - getTags (Tag) - integration (Integration) - owner (User) - score (Float) - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only). - _id (String) - conversations (Conversation) --- ## customersMerge **Type:** GraphQL mutations **Description:** Merge several customers into one, applying provided override fields. ### Arguments - customerIds (String) - customerFields (JSON) ### Response **Type:** Customer **Description:** Customer/contact entity capturing personal details, subscription status, and engagement metadata. #### Fields - state (String) - createdAt (Date) - modifiedAt (Date) - avatar (String) - integrationId (String) - firstName (String) - lastName (String) - birthDate (Date) - sex (Int) - email (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - phone (String) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - ownerId (String) - leadStatus (String) - leadStageHistory (LeadStageHistoryEntry) - description (String) - isSubscribed (String) - code (String) - emailValidationStatus (String) - phoneValidationStatus (String) - links (JSON) - companies (Company) - getTags (Tag) - integration (Integration) - owner (User) - score (Float) - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only). - _id (String) - conversations (Conversation) --- ## customersRemove **Type:** GraphQL mutations **Description:** Remove one or more customers; returns removed ids. ### Arguments - customerIds (String) ### Response **Type:** String --- ## customersChangeState **Type:** GraphQL mutations **Description:** Change the lifecycle state for a customer (e.g., lead → customer); value expects a known state key. ### Arguments - _id (String) - value (String) ### Response **Type:** Customer **Description:** Customer/contact entity capturing personal details, subscription status, and engagement metadata. #### Fields - state (String) - createdAt (Date) - modifiedAt (Date) - avatar (String) - integrationId (String) - firstName (String) - lastName (String) - birthDate (Date) - sex (Int) - email (String) - primaryEmail (String) - emails (String) - primaryPhone (String) - phones (String) - primaryAddress (JSON) - addresses (JSON) - phone (String) - tagIds (String) - customFieldsData (JSON) - customFieldsDataByFieldCode (JSON) - ownerId (String) - leadStatus (String) - leadStageHistory (LeadStageHistoryEntry) - description (String) - isSubscribed (String) - code (String) - emailValidationStatus (String) - phoneValidationStatus (String) - links (JSON) - companies (Company) - getTags (Tag) - integration (Integration) - owner (User) - score (Float) - segmentsV2 (CustomerSegmentV2Membership): Active segments-v2 memberships for this customer (active version only). - _id (String) - conversations (Conversation)