JSONString

link GraphQL Schema definition

link Require by

• AccountEntityCompany or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.
• AccountRepositoryRead operations for Account records.
• AccountTypeEntityConfigurable category of accounts that defines the form layout and settings used for accounts of that type.
• ActivityEntityTask or appointment: the common view of the to-dos and meetings of the sales team, linked to the records they concern.
• AiContextRecord an AI chat conversation is about, with the screen it was started from.
• AppointmentEntityMeeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns.
• AppointmentRepositoryRead operations for Appointment records.
• AppointmentTypeEntityConfigurable category of appointments, such as a meeting or a call, that defines their form layout and icon.
• ApprovalEntityApproval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers.
• ApprovalProcessActivityLogLineEntityEntry in the activity log of an approval, recording one step of the approval and its result.
• ClientSettingEntityPersonal setting of a user, stored as a named value.
• CloudObjectEntityFile stored in the space, such as a document, image or recording, that can be attached to records.
• CompanyEmailEntityShared company mailbox connected to the space that users can send emails from, such as a sales or support address.
• ContactEntityPerson the sales team works with, usually linked to one or more accounts, leads and opportunities.
• ContactRepositoryRead operations for Contact records.
• ContactTypeEntityConfigurable category of contacts that defines the form layout and settings used for contacts of that type.
• CreateAccountInputField values of a new Account record.
• CreateAppointmentInputField values of a new Appointment record.
• CreateApprovalProcessActivityLogLineInputField values of a new ApprovalProcessActivityLogLine record.
• CreateApprovalProcessInputField values of a new ApprovalProcess record.
• CreateCloudObjectInputField values of a new CloudObject record.
• CreateContactInputField values of a new Contact record.
• CreateDataInputField values of a new Data record.
• CreateDraftFieldInputParameters of the createField mutation.
• CreateEmailEventInputField values of a new EmailEvent record.
• CreateEmailInputField values of a new Email record.
• CreateEmailTemplateInputField values of a new EmailTemplate record.
• CreateForecastInputField values of a new Forecast record.
• CreateGhostLeadOpptyContactRelationInputField values of a new GhostLeadOpptyContactRelation record.
• CreateImportMappingMaskInputField values of a new ImportMappingMask record.
• CreateLeadInputField values of a new Lead record.
• CreateLeadOpptyContactGroupRelationInputField values of a new LeadOpptyContactGroupRelation record.
• CreateLeadOpptyContactRelationInputField values of a new LeadOpptyContactRelation record.
• CreateLeadOpptyContactRelationNoLeadOpptyBackrefInputField values of a new LeadOpptyContactRelation record, created together with the record it belongs to.
• CreateOnlineFormInputField values of a new OnlineForm record.
• CreateOnlineFormStyleInputField values of a new OnlineFormStyle record.
• CreateOnlineFormTypeInputField values of a new OnlineFormType record.
• CreateOpportunityInputField values of a new Opportunity record.
• CreateOpptyProductRelationInputField values of a new OpptyProductRelation record.
• CreateOpptyProductRelationNoBackrefInputField values of a new OpptyProductRelation record, created together with the record it belongs to.
• CreateOrUpdateAccountInputField values of an Account record to create, or to update when its id is set.
• CreateOrUpdateAppointmentInputField values of an Appointment record to create, or to update when its id is set.
• CreateOrUpdateApprovalProcessActivityLogLineInputField values of an ApprovalProcessActivityLogLine record to create, or to update when its id is set.
• CreateOrUpdateApprovalProcessInputField values of an ApprovalProcess record to create, or to update when its id is set.
• CreateOrUpdateCloudObjectInputField values of a CloudObject record to create, or to update when its id is set.
• CreateOrUpdateContactInputField values of a Contact record to create, or to update when its id is set.
• CreateOrUpdateEmailEventInputField values of an EmailEvent record to create, or to update when its id is set.
• CreateOrUpdateEmailInputField values of an Email record to create, or to update when its id is set.
• CreateOrUpdateEmailTemplateInputField values of an EmailTemplate record to create, or to update when its id is set.
• CreateOrUpdateForecastInputField values of a Forecast record to create, or to update when its id is set.
• CreateOrUpdateGhostLeadOpptyContactRelationInputField values of a GhostLeadOpptyContactRelation record to create, or to update when its id is set.
• CreateOrUpdateImportMappingMaskInputField values of an ImportMappingMask record to create, or to update when its id is set.
• CreateOrUpdateLeadInputField values of a Lead record to create, or to update when its id is set.
• CreateOrUpdateLeadOpptyContactGroupRelationInputField values of a LeadOpptyContactGroupRelation record to create, or to update when its id is set.
• CreateOrUpdateLeadOpptyContactRelationInputField values of a LeadOpptyContactRelation record to create, or to update when its id is set.
• CreateOrUpdateMediaInputField values of a Media record to create, or to update when its id is set.
• CreateOrUpdateOnlineFormInputField values of an OnlineForm record to create, or to update when its id is set.
• CreateOrUpdateOnlineFormStyleInputField values of an OnlineFormStyle record to create, or to update when its id is set.
• CreateOrUpdateOnlineFormTypeInputField values of an OnlineFormType record to create, or to update when its id is set.
• CreateOrUpdateOpportunityInputField values of an Opportunity record to create, or to update when its id is set.
• CreateOrUpdateOpptyProductRelationInputField values of an OpptyProductRelation record to create, or to update when its id is set.
• CreateOrUpdateOpptyProductRelationNoBackrefInputField values of an OpptyProductRelation record to create, or to update when its id is set, together with the record it belongs to.
• CreateOrUpdateProcessActivityLogInputField values of a ProcessActivityLog record to create, or to update when its id is set.
• CreateOrUpdateProductInputField values of a Product record to create, or to update when its id is set.
• CreateOrUpdateProductPriceListInputField values of a ProductPriceList record to create, or to update when its id is set.
• CreateOrUpdateProjectInputField values of a Project record to create, or to update when its id is set.
• CreateOrUpdateQuoteInputField values of a Quote record to create, or to update when its id is set.
• CreateOrUpdateSolutionTemplateInputField values of a SolutionTemplate record to create, or to update when its id is set.
• CreateOrUpdateTagInputField values of a Tag record to create, or to update when its id is set.
• CreateOrUpdateTaskInputField values of a Task record to create, or to update when its id is set.
• CreateOrUpdateWebhookInputField values of a Webhook record to create, or to update when its id is set.
• CreateProcessActivityLogInputField values of a new ProcessActivityLog record.
• CreateProductInputField values of a new Product record.
• CreateProductNoProductCategoryBackrefInputField values of a new Product record, created together with the record it belongs to.
• CreateProductPriceListInputField values of a new ProductPriceList record.
• CreateProjectInputField values of a new Project record.
• CreateQuoteInputField values of a new Quote record.
• CreateQuoteNoOpptyBackrefInputField values of a new Quote record, created together with the record it belongs to.
• CreateSolutionTemplateInputField values of a new SolutionTemplate record.
• CreateTagInputField values of a new Tag record.
• CreateTaskInputField values of a new Task record.
• CreateWebhookInputField values of a new Webhook record.
• CustomEntityEntityRecord of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities.
• CustomEntityRelationEntityCustom relation that links records of two entities through a pair of relation fields, one on each side.
• CustomEntityRepositoryRead operations for CustomEntity records.
• CustomEntityTypeEntityConfigurable category of records of a custom entity that defines their form layout and settings; entityApiName names the custom entity.
• DataEntityOption of a dropdown or multi-select field, one of the values users can choose from.
• EmailEntityEmail message sent or received by users of the space, linked to the contacts, accounts and other records it concerns.
• EmailEventEntityTracking event reported for a sent email, such as an open, a link click, a reply or an unsubscribe.
• EmailMailboxRelationEntityLink between an email and a mailbox the email belongs to.
• EntityEntityKind of record in the space, such as Account, Lead or a custom entity, with its display names and behavior.
• EntityHealthIndicatorResult of one health indicator rule for a record.
• FieldDataContainerValue of one field in a row of a data grid view.
• FieldDataSetItemOption of a dropdown, radio or multiselect field, as set when creating or changing a draft field.
• FieldDescriptorDescription of a field: its names, type, the access level of the current user and its type-specific settings.
• FieldEntityField of an entity, built-in or custom, with its name, type and configuration.
• FieldMappingTemplateField-to-field mapping of a field mapping: default values and per-field operations for the target record.
• FieldMappingTemplateParamsField-to-field mapping of a field mapping: default values and per-field operations for the target record.
• FieldSequenceEntityNumbering pattern of an auto-number field, used to generate its values for records that match the filter of the sequence.
• ForecastEntitySales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users.
• FormFieldField placed on a record form, with its label, validation and conditional rules.
• GhostLeadOpptyContactRelationEntityPlacement of a ghost contact on the org chart of a lead or an opportunity.
• ImportMappingMaskEntitySaved mapping of import file columns to fields, reused when importing records of the same entity.
• LeadEntityPotential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.
• LeadOpptyContactGroupRelationEntityGroup of contacts on the org chart of a lead or opportunity.
• LeadOpptyContactRelationEntityLink between a lead or opportunity and a contact, with the contact's sales roles and org-chart position.
• LeadOpptyEntityLead or opportunity, with the fields both kinds of sales records share.
• LeadRepositoryRead operations for Lead records.
• LeadTypeEntityLead type that classifies leads and defines their forms and the lead process they follow.
• MediaEntityRecording of a call or meeting with its transcription and AI summary, attached to a call, task or appointment.
• OnlineFormEntitySubmission (response) of an online form, with the answers and the records it created or updated.
• OnlineFormRepositoryRead operations for OnlineForm records.
• OnlineFormTypeEntityOnline form definition: the fields and settings of a web form whose submissions create or update records.
• OpportunityEntityPotential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
• OpportunityRepositoryRead operations for Opportunity records.
• OpportunityTypeEntityOpportunity type that classifies opportunities and defines their forms (edit, qualify, won and lost).
• OpptyProductRelationEntityProduct line item on an opportunity or quote, with its quantity, price and discount.
• OpptyProductRelationRepositoryRead operations for OpptyProductRelation records.
• OpptyProductRelationTypeEntityLine-item type that defines the form of product line items on opportunities and quotes; paired with a product type.
• ProcessActivityLogEntityOne run of an Automatizer process, with its status, timing and the steps it took.
• ProcessEntityTemplateValues that a process, email sequence or online form sets on a record it creates or updates.
• ProductEntityProduct or service in the catalog that can be added as a line item to opportunities and quotes.
• ProductRepositoryRead operations for Product records.
• ProductTypeEntityProduct type that classifies products and defines their form.
• ProfileEntitySaved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.
• ProjectEntityProject delivered for an account or run internally, with its objectives, activities and progress.
• ProjectRepositoryRead operations for Project records.
• ProjectTypeEntityProject type that classifies projects and defines their form and icon.
• QuoteEntityPrice offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process.
• QuoteRepositoryRead operations for Quote records.
• QuoteTypeEntityQuote type that classifies quotes and defines their forms and the quote process they follow.
• TaskEntityTask (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records.
• TaskRepositoryRead operations for Task records.
• TaskTypeEntityTask type that classifies tasks and defines their form and icon.
• TypeEntityData type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped.
• UpdateAccountInputId of an Account record and the field values to change.
• UpdateAppointmentInputId of an Appointment record and the field values to change.
• UpdateApprovalProcessActivityLogLineInputId of an ApprovalProcessActivityLogLine record and the field values to change.
• UpdateApprovalProcessInputId of an ApprovalProcess record and the field values to change.
• UpdateCloudObjectInputId of a CloudObject record and the field values to change.
• UpdateContactInputId of a Contact record and the field values to change.
• UpdateDataInputId of a Data record and the field values to change.
• UpdateDraftFieldInputParameters of the updateField mutation.
• UpdateEmailEventInputId of an EmailEvent record and the field values to change.
• UpdateEmailInputId of an Email record and the field values to change.
• UpdateEmailTemplateInputId of an EmailTemplate record and the field values to change.
• UpdateForecastInputId of a Forecast record and the field values to change.
• UpdateGhostLeadOpptyContactRelationInputId of a GhostLeadOpptyContactRelation record and the field values to change.
• UpdateImportMappingMaskInputId of an ImportMappingMask record and the field values to change.
• UpdateLeadInputId of a Lead record and the field values to change.
• UpdateLeadOpptyContactGroupRelationInputId of a LeadOpptyContactGroupRelation record and the field values to change.
• UpdateLeadOpptyContactRelationInputId of a LeadOpptyContactRelation record and the field values to change.
• UpdateMediaInputId of a Media record and the field values to change.
• UpdateOnlineFormInputId of an OnlineForm record and the field values to change.
• UpdateOnlineFormStyleInputId of an OnlineFormStyle record and the field values to change.
• UpdateOnlineFormTypeInputId of an OnlineFormType record and the field values to change.
• UpdateOpportunityInputId of an Opportunity record and the field values to change.
• UpdateOpptyProductRelationInputId of an OpptyProductRelation record and the field values to change.
• UpdateProcessActivityLogInputId of a ProcessActivityLog record and the field values to change.
• UpdateProductInputId of a Product record and the field values to change.
• UpdateProductPriceListInputId of a ProductPriceList record and the field values to change.
• UpdateProjectInputId of a Project record and the field values to change.
• UpdateQuoteInputId of a Quote record and the field values to change.
• UpdateSolutionTemplateInputId of a SolutionTemplate record and the field values to change.
• UpdateTagInputId of a Tag record and the field values to change.
• UpdateTaskInputId of a Task record and the field values to change.
• UpdateWebhookInputId of a Webhook record and the field values to change.
• WebhookEntityRegistered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. Recipient has to receive the webhook in 10 seconds and respond with HTTP 200 (2XX) status. On failed delivery it will be retried up to 10 times within 24 hours. If the receiving side will respond with HTTP 410 status, the webhook will be disabled. Webhook is also disabled when we receive HTTP timeout on 10th retry and there was no successful delivery in last 5 days.