Mutations

accept_company_documents

Schema: company

Type: Mutation

Returns: BulkStatusResponse

accept_company_documents(
  "Ids of the documents to accept"
  ids: [Id!]!
): BulkStatusResponse

accept_user_documents

Schema: user

Type: Mutation

Returns: BulkStatusResponse

accept_user_documents(
  "Ids of the documents to accept"
  ids: [Id!]!
): BulkStatusResponse

add_company_document_tag

Schema: company

Type: Mutation

Returns: StatusResponse

add_company_document_tag(
  "The document id"
  document_id: Id!
  "The tag id"
  tag_id: Id!
): StatusResponse

add_ten_dlc_api_key

Schema: company

Type: Mutation

Returns: TenDlcApiKey

add_ten_dlc_api_key(
  "TCR API Key"
  api_key: String!
  "TCR API Key Secret"
  api_key_secret: String!
  "API Key name/label"
  name: String!
): TenDlcApiKey

add_user_document_tag

Schema: user

Type: Mutation

Returns: StatusResponse

add_user_document_tag(
  "The document id"
  document_id: Id!
  "The tag id"
  tag_id: Id!
): StatusResponse

ask_company_document_question

Schema: company

Type: Mutation

Returns: DocumentAnswer

ask_company_document_question(
  "The natural-language question to answer from the company's documents"
  question: String!
): DocumentAnswer

ask_docs_question

Schema: user, company

Type: Mutation

Returns: DocsAnswer

ask_docs_question(
  "The places the caller can open. Omit to be answered from the documentation alone."
  navigation: [NavigationEntryInput!]
  "The natural-language question to answer"
  question: String!
): DocsAnswer

ask_user_document_question

Schema: user

Type: Mutation

Returns: DocumentAnswer

ask_user_document_question(
  "The natural-language question to answer from the user's documents"
  question: String!
): DocumentAnswer

authorize_ten_dlc_api_key

Schema: company

Type: Mutation

Returns: TenDlcApiKeyAuthorization

authorize_ten_dlc_api_key(
  "ID of the API key to share"
  api_key_id: Uuid!
  "ID of the company that should be authorized to use the API key"
  authorized_company_id: Uuid!
): TenDlcApiKeyAuthorization

complete_onboarding_step

Schema: user

Type: Mutation

Returns: OnboardingStatus

complete_onboarding_step(
  "The status to set"
  status: OnboardingStepStatus!
  "The step to update"
  step: OnboardingStep!
): OnboardingStatus

confirm_document_upload

Schema: user, company

Type: Mutation

Returns: Document

confirm_document_upload(
  "Id returned by prepareDocumentUpload"
  id: Id!
): Document

create_b2b_connection_request

Schema: company

Type: Mutation

Returns: B2bConnectionRequest

create_b2b_connection_request(
  "Type of the relationship you want to create"
  connection_type: B2bConnectionType!
  "Id of the company you want to send connection request to"
  invited_company_id: Id!
): B2bConnectionRequest

create_b2b_form_submission_request

Schema: company

Type: Mutation

Returns: B2bFormSubmissionRequest

create_b2b_form_submission_request(
  "The ID of the form"
  form_id: Id!
  "The ID of the company to request"
  submitter_id: Id!
): B2bFormSubmissionRequest

create_b2b_invite

Schema: company

Type: Mutation

Returns: B2bConnectionRequest

create_b2b_invite(
  "Information of the company you want to create"
  company: CompanyInput!
  "Type of the relationship you want to create"
  connection_type: B2bConnectionType!
  "Information of the representatives you want to create"
  representatives: [InviteUserInput!]!
): B2bConnectionRequest

create_b2c_connection_request

Schema: company

Type: Mutation

Returns: B2cConnectionRequest

create_b2c_connection_request(
  "Type of the relationship you want to create"
  connection_type: B2cConnectionType!
  "Id of the user you want to send connection request to"
  invited_user_id: Id!
): B2cConnectionRequest

create_b2c_form_submission_request

Schema: company

Type: Mutation

Returns: B2cFormSubmissionRequest

create_b2c_form_submission_request(
  "The ID of the form"
  form_id: Id!
  "The ID of the user to request"
  submitter_id: Id!
): B2cFormSubmissionRequest

create_b2c_invite

Schema: company

Type: Mutation

Returns: B2cConnectionRequest

create_b2c_invite(
  "Type of the relationship you want to create"
  connection_type: B2cConnectionType!
  "Information of the user you want to create"
  user: InviteUserInput!
): B2cConnectionRequest

create_b2c_subscription_request

Schema: company

Type: Mutation

Returns: B2cSubscriptionRequest

create_b2c_subscription_request(
  "Id of the user you want to send subscription request to"
  invited_user_id: Id!
  "Subscription topic IDs the request applies to. Enables picking a subset
of its topics for each request. Empty/nil means no topics attached."
  subscription_topic_ids: [Id!]
  "Type of the subscription"
  type: B2cSubscriptionType!
): B2cSubscriptionRequest

create_b2c_subscription_topic

Schema: company

Type: Mutation

Returns: B2cSubscriptionTopic

create_b2c_subscription_topic(
  description: String
  enable_email: Boolean
  enable_sms: Boolean
  enable_voice: Boolean
  "Unique name of the topic"
  name: String!
  type: B2cSubscriptionTopicType
): B2cSubscriptionTopic

create_c2b_connection_request

Schema: user

Type: Mutation

Returns: C2bConnectionRequest

create_c2b_connection_request(
  "Type of the relationship you want to create"
  connection_type: B2cConnectionType!
  "Id of the company you want to send connection request to"
  invited_company_id: Id!
): C2bConnectionRequest

create_c2c_connection_request

Schema: user

Type: Mutation

Returns: C2cConnectionRequest

create_c2c_connection_request(
  "Type of the relationship you want to create"
  connection_type: C2cConnectionType!
  "Id of the user you want to send connection request to"
  invited_user_id: Id!
): C2cConnectionRequest

create_c2c_invite

Schema: user

Type: Mutation

Returns: C2cConnectionRequest

create_c2c_invite(
  "Type of the relationship you want to create"
  connection_type: C2cConnectionType!
  "Information of the user you want to create"
  user: InviteUserInput!
): C2cConnectionRequest

create_client_secret

Schema: company

Type: Mutation

Returns: ClientSecret

create_client_secret(
  "Human-readable description of the client secret"
  description: String
): ClientSecret

create_company

Schema: user

Type: Mutation

Returns: Company

create_company(
  "About us of the company"
  about_us: String
  "About us visibility of the company"
  about_us_visibility: [CompanyVisibilityType!]
  "Addresses of the company"
  addresses: [CompanyAddressInput]
  "B2C relation visibility of the company"
  b2c_visibility: [CompanyVisibilityType!]
  "Brand name of the company"
  brand_name: String
  "Brand name visibility of the company"
  brand_name_visibility: [CompanyVisibilityType!]
  "Specialty ids of the company"
  company_specialties: [Id]
  "Type of the relationship to the company"
  connection_type: AdminB2cConnectionType
  "Email addresses of the company"
  emails: [CompanyEmailInput]
  "Legal name of the company"
  legal_name: String!
  "Legal name visibility of the company"
  legal_name_visibility: [CompanyVisibilityType!]
  "Logo url visibility of company"
  logo_url_visibility: [CompanyVisibilityType!]
  "Additional information"
  metadata: Json
  "Metadata visibility of the company"
  metadata_visibility: [CompanyVisibilityType!]
  "Organization type id of the company"
  organization_type_id: Id
  "Organization type visibility of the company"
  organization_type_visibility: [CompanyVisibilityType!]
  "Profile name of the company"
  profile_name: String!
  "Optionally create Client secret to take up the role of the company right away post creation"
  provision_company_client_secret: Boolean
  "Social media pages of the company"
  social_networks: [CompanySocialMediaInput]
  "Specialties visibility of the company"
  specialties_visibility: [CompanyVisibilityType!]
  "Subscription settings of the company"
  subscription_settings: CompanySubscriptionSettingsInput
  "Subscription topics of the company"
  subscription_topics: [B2cSubscriptionTopicInput]
  "Tax IDs of the company (EIN, Sales Tax, etc.)"
  tax_ids: [CompanyTaxIdInput]
  "Telephone numbers of the company"
  telephone_numbers: [CompanyTelephoneNumberInput]
  "Trusted domains of the company"
  trusted_domains: [TrustedDomainInput]
  "Vertical type id of the company"
  vertical_type_id: Id
  "Vertical type visibility of the company"
  vertical_type_visibility: [CompanyVisibilityType!]
  "Webpages of the company"
  webpages: [CompanyWebpageInput]
  "Year of foundation of the company"
  year_founded: Integer
  "Year of foundation visibility of the company"
  year_founded_visibility: [CompanyVisibilityType!]
): Company

create_company_address

Schema: company

Type: Mutation

Returns: Address

create_company_address(
  "City of the address"
  city: String!
  "Country of the address"
  country: String!
  "State of the address"
  state: String
  "Street of the address"
  street: String!
  "Types of the address"
  types: [CompanyAddressType!]
  "Visibility of the address"
  visibility: [CompanyVisibilityType!]
  "Zip code of the address"
  zip_code: String!
): Address

create_company_ai_task

Schema: company

Type: Mutation

Returns: AiTask

create_company_ai_task(
  "The folders to watch, each covering everything beneath it; omit for a task that runs only against the documents a run names"
  folder_ids: [Id!]
  "What to call the task"
  name: String!
  "The answer's shape: names to types, where a value may be an object or a one-element list for a repeated entry"
  output_shape: Json!
  "The instructions to run against each document"
  prompt: String!
  "Watch the whole repository, whatever folders it holds now or later; folders named alongside this are dropped"
  run_on_root: Boolean
): AiTask

create_company_client_secret

Schema: user

Type: Mutation

Returns: ClientSecret

create_company_client_secret(
  "Company id that the client secret belongs to"
  company_id: Id!
  "Description of the client secret"
  description: String
): ClientSecret

create_company_email

Schema: company

Type: Mutation

Returns: Email

create_company_email(
  "Email address"
  email: String!
  "Types of the email"
  types: [CompanyEmailType!]
  "Visibility of the email"
  visibility: [CompanyVisibilityType!]
): Email

create_company_email_verification_code

Schema: company

Type: Mutation

Returns: OtpData

create_company_email_verification_code(
  "Branding token minted by the partner company's backend; the message then names that company"
  branding_token: String
  "Id of the company email"
  email_id: Id!
): OtpData

create_company_folder

Schema: company

Type: Mutation

Returns: Folder

create_company_folder(
  "The folder name"
  name: String!
  "The parent folder id; omit for a folder at the repository root"
  parent_id: Id
): Folder

create_company_invitation_link

Schema: company

Type: Mutation

Returns: InvitationLink

create_company_invitation_link(
  "Allow subscribing without creating a TNID account"
  allow_anonymous_subscription: Boolean
  "Allow connecting user to the inviting user's personal connections"
  allow_user_connection: Boolean
  "B2C connection type for joining users"
  b2c_connection_type: B2cConnectionType
  "C2C connection type for joining users (if allow_user_connection is true)"
  c2c_connection_type: C2cConnectionType
  "Name for the invitation link"
  name: String
  "Request email subscription for joining users"
  request_email_subscription: Boolean
  "Request SMS subscription for joining users"
  request_sms_subscription: Boolean
  "Request voice subscription for joining users"
  request_voice_subscription: Boolean
): InvitationLink

create_company_tag

Schema: company

Type: Mutation

Returns: Tag

create_company_tag(
  "The tag name"
  name: String!
): Tag

create_company_telephone_number

Schema: company

Type: Mutation

Returns: TelephoneNumber

create_company_telephone_number(
  "Country code of the telephone number"
  country_code: String!
  "Telephone number without country code"
  number: String!
  "Additional information"
  types: [CompanyTelephoneNumberType!]
  "Visibility of the telephone number"
  visibility: [CompanyVisibilityType!]
): TelephoneNumber

create_company_telephone_number_verification_code

Schema: company

Type: Mutation

Returns: OtpData

create_company_telephone_number_verification_code(
  "Branding token minted by the partner company's backend; the message then names that company"
  branding_token: String
  "Id of the company telephone number"
  telephone_number_id: Id!
): OtpData

create_company_webhook

Schema: company

Type: Mutation

Returns: CompanyWebhook

create_company_webhook(
  "Whether webhook should be used for B2B connection request received event"
  b2b_connection_request_received_webhook: Boolean
  "Whether webhook should be used for B2B connection response received event"
  b2b_connection_request_response_webhook: Boolean
  "Whether webhook should be used for B2B form instance subsmission request received event"
  b2b_form_instance_submission_request_received_webhook: Boolean
  "Whether webhook should be used for B2C connection request response event"
  b2c_connection_request_response_webhook: Boolean
  "Whether webhook should be used for B2C subscription request response event"
  b2c_subscription_request_response_webhook: Boolean
  "Bearer token to be used with the webhook"
  bearer_token: String
  "Whether webhook should be used for C2B connection request received event"
  c2b_connection_request_received_webhook: Boolean
  "Whether webhook should be used for Company social network status change event"
  company_social_network_status_change_webhook: Boolean
  "Custom headers to be used with the webhook"
  custom_headers: Json
  "Name of the webhook"
  name: String
  "Whether webhook should be used for opt-out event"
  receive_opt_out_events: Boolean
  "Whether webhook should be used for subscription event"
  receive_subscription_events: Boolean
  "URL of the webhook"
  url: String!
): CompanyWebhook

create_form

Schema: company

Type: Mutation

Returns: Form

create_form(
  "Description of the form"
  description: String
  "Who the form is intended for"
  intended_for: [FormBuilderFormIntendedFor!]
  "Title of the form"
  title: String!
  "Visibility settings"
  visibility: [FormBuilderFormVisibility!]
): Form

create_form_version

Schema: company

Type: Mutation

Returns: FormVersion

create_form_version(
  "Fields for the new version"
  fields: [FormVersionFieldInput!]!
  "The ID of the form"
  form_id: Id!
  "Publish this version immediately"
  published: Boolean
): FormVersion

create_group

Schema: user

Type: Mutation

Returns: Group

create_group(
  "Additional information"
  metadata: Json
  "Name of the group"
  name: String!
  "Visibility of the group"
  visibility: [GroupVisibilityType!]
): Group

create_group_user_member_invite

Schema: user

Type: Mutation

Returns: GroupUserMemberInvite

create_group_user_member_invite(
  "Id of the Group the user is being invited to"
  group_id: Id!
  "Id of the user you want to send the invite to"
  invited_user_id: Id!
  "Role of the user in the group"
  role: GroupRoleType!
): GroupUserMemberInvite

create_group_user_member_join_request

Schema: user

Type: Mutation

Returns: GroupUserMemberJoinRequest

create_group_user_member_join_request(
  "Id of the Group the user wants to join"
  group_id: Id!
): GroupUserMemberJoinRequest

create_opt_out_request

Schema: company

Type: Mutation

Returns: OptOutRequest

create_opt_out_request(
  "Request destination - email, phone number, username or any other identifier where request was sent to"
  destination: String!
  "External resource id (if applicable) where opt-out request was received (eg. message id)"
  external_id: String
  "Textual part of the entire message in which opt-out is requested"
  message_body: String
  "Any additional information as stringified JSON"
  metadata: Json
  "Request origin - email, phone number, username or any other identifier from where request was sent"
  source: String!
  "Date and time when the opt-out request was initially received"
  timestamp: NaiveDatetime!
  "Type of the request you want to create"
  type: OptOutRequestType!
): OptOutRequest

create_spam_report

Schema: user

Type: Mutation

Returns: SpamReport

create_spam_report(
  "Channel type of the spam report you want to create"
  channel_type: SpamReportChannelType!
  "Destination of the content that the report is about"
  destination: String
  "Origin number of the content that the report is about"
  from_number: String
  "Issue type of the spam report you want to create"
  issue_type: SpamReportIssueType
  "Content of the SMS the report is about"
  message_content: String
  "Any additional information as stringified JSON"
  metadata: Json
  "Date and time of the incident"
  reported_at: NaiveDatetime
  "Source of the content that the report is about"
  source: String
  "Date and time of the incident"
  timestamp: NaiveDatetime
  "Receiver number of the content that the report is about"
  to_number: String
  "Aditional notes by the user"
  user_note: String
): SpamReport

create_support_request

Schema: user

Type: Mutation

Returns: StatusResponse

create_support_request(
  "The email address to reply to"
  email: String!
  "The support message"
  message: String!
): StatusResponse

create_user_address

Schema: user

Type: Mutation

Returns: Address

create_user_address(
  "City of the address"
  city: String!
  "Country of the address"
  country: String!
  "State of the address"
  state: String
  "Street of the address"
  street: String!
  "Types of the address"
  types: [UserAddressType!]
  "Visibility of the address"
  visibility: [UserVisibilityType!]
  "Zip code of the address"
  zip_code: String!
): Address

create_user_ai_task

Schema: user

Type: Mutation

Returns: AiTask

create_user_ai_task(
  "The folders to watch, each covering everything beneath it; omit for a task that runs only against the documents a run names"
  folder_ids: [Id!]
  "What to call the task"
  name: String!
  "The answer's shape: names to types, where a value may be an object or a one-element list for a repeated entry"
  output_shape: Json!
  "The instructions to run against each document"
  prompt: String!
  "Watch the whole repository, whatever folders it holds now or later; folders named alongside this are dropped"
  run_on_root: Boolean
): AiTask

create_user_email

Schema: user

Type: Mutation

Returns: UserEmail

create_user_email(
  "Email address"
  email: String!
  "Types of the email"
  types: [UserEmailType!]
  "Visibility of the email"
  visibility: [UserVisibilityType!]
): UserEmail

create_user_email_verification_code

Schema: user

Type: Mutation

Returns: OtpData

create_user_email_verification_code(
  "Branding token minted by the partner company's backend; the message then names that company"
  branding_token: String
  "Id of the email"
  email_id: Id!
): OtpData

create_user_event

Schema: user

Record an event about the calling user. The ledger is append-only: events cannot be changed or deleted, and a correction is recorded as a new event. Posting an external_ref again returns the event already recorded under it, unchanged.

Type: Mutation

Returns: UserEvent

create_user_event(
  "Event token minted by the partner company's backend for the calling user"
  event_token: String!
  "The poster's unique reference for the event, used to make posting idempotent"
  external_ref: String!
  "When the event happened"
  occurred_at: Datetime!
  "A JSON object with the event's data; its shape is defined by the event type"
  payload: Json!
  "The user the event is about; currently only the calling user is accepted"
  subject_user_id: Id
  "Dot-separated event type starting with the company's prefix (e.g. hoozit.order.completed)"
  type: String!
): UserEvent

create_user_folder

Schema: user

Type: Mutation

Returns: Folder

create_user_folder(
  "The folder name"
  name: String!
  "The parent folder id; omit for a folder at the repository root"
  parent_id: Id
): Folder

create_user_tag

Schema: user

Type: Mutation

Returns: Tag

create_user_tag(
  "The tag name"
  name: String!
): Tag

create_user_telephone_number

Schema: user

Type: Mutation

Returns: UserTelephoneNumber

create_user_telephone_number(
  "Country code of the telephone number"
  country_code: String!
  "Telephone number without country code"
  number: String!
  "Additional information"
  types: [UserTelephoneNumberType!]
  "Visibility of the telephone number"
  visibility: [UserVisibilityType!]
): UserTelephoneNumber

create_user_telephone_number_verification_code

Schema: user

Type: Mutation

Returns: OtpData

create_user_telephone_number_verification_code(
  "Branding token minted by the partner company's backend; the message then names that company"
  branding_token: String
  "Id of the telephone_number"
  telephone_number_id: Id!
): OtpData

delete_client_secret

Schema: company

Type: Mutation

Returns: StatusResponse

delete_client_secret(
  "Id of the client secret to delete"
  id: Id!
): StatusResponse

delete_company

Schema: user

Type: Mutation

Returns: StatusResponse

delete_company(
  "The ID of the company to delete"
  company_id: Id!
): StatusResponse

delete_company_ai_task

Schema: company

Type: Mutation

Returns: StatusResponse

delete_company_ai_task(
  id: Id!
): StatusResponse

delete_company_documents

Schema: company

Type: Mutation

Returns: BulkStatusResponse

delete_company_documents(
  "Ids of the documents to move to the trash"
  ids: [Id!]!
): BulkStatusResponse

delete_company_folders

Schema: company

Type: Mutation

Returns: BulkStatusResponse

delete_company_folders(
  "Ids of the folders to delete"
  ids: [Id!]!
): BulkStatusResponse

delete_company_invitation_link

Schema: company

Type: Mutation

Returns: StatusResponse

delete_company_invitation_link(
  "The ID of the invitation link to delete"
  id: Id!
): StatusResponse

delete_company_tag

Schema: company

Type: Mutation

Returns: StatusResponse

delete_company_tag(
  "The tag id"
  id: Id!
): StatusResponse

delete_form

Schema: company

Type: Mutation

Returns: StatusResponse

delete_form(
  "The ID of the form to delete"
  form_id: Id!
): StatusResponse

delete_ten_dlc_api_key

Schema: company

Type: Mutation

Returns: TenDlcApiKey

delete_ten_dlc_api_key(
  "API Key ID to delete"
  id: String!
): TenDlcApiKey

delete_ten_dlc_brand

Schema: company

Type: Mutation

Returns: StatusResponse

delete_ten_dlc_brand(
  "Internal brand identifier (UUID)"
  id: Id!
): StatusResponse

delete_ten_dlc_campaign

Schema: company

Type: Mutation

Returns: StatusResponse

delete_ten_dlc_campaign(
  "Internal campaign identifier (UUID)"
  id: Id!
): StatusResponse

delete_user_ai_task

Schema: user

Type: Mutation

Returns: StatusResponse

delete_user_ai_task(
  id: Id!
): StatusResponse

delete_user_documents

Schema: user

Type: Mutation

Returns: BulkStatusResponse

delete_user_documents(
  "Ids of the documents to move to the trash"
  ids: [Id!]!
): BulkStatusResponse

delete_user_folders

Schema: user

Type: Mutation

Returns: BulkStatusResponse

delete_user_folders(
  "Ids of the folders to delete"
  ids: [Id!]!
): BulkStatusResponse

delete_user_tag

Schema: user

Type: Mutation

Returns: StatusResponse

delete_user_tag(
  "The tag id"
  id: Id!
): StatusResponse

empty_company_trash

Schema: company

Type: Mutation

Returns: BulkStatusResponse

empty_company_trash: BulkStatusResponse

empty_user_trash

Schema: user

Type: Mutation

Returns: BulkStatusResponse

empty_user_trash: BulkStatusResponse

feedback_on_detected_unsubscribe

Schema: company

Type: Mutation

Returns: StatusResponse

feedback_on_detected_unsubscribe(
  "The action, whether to unsubscribe the user or not."
  action: UnsubscribeType!
  "The ID of the external communication message that triggered the unsubscribe feedback."
  external_communication_id: String!
): StatusResponse

generate_sms_opt_in_qr_code

Schema: company

Type: Mutation

Returns: SmsOptInQrCode

generate_sms_opt_in_qr_code(
  "Ids of topics that the the user opts into"
  subscription_topic_ids: [Id!]!
  "Opt in telephone number id that the opt in sms will be sent to"
  telephone_number_id: Id!
  "Type of contact the user opts into"
  type: SmsOptInQrCodeType!
): SmsOptInQrCode

get_ai_company_profile_suggestions

Schema: company

Type: Mutation

Returns: CompanyProfileSuggestions

get_ai_company_profile_suggestions(
  "Website URL to scrape (with or without scheme — `https://` is assumed when omitted)"
  website_url: String!
): CompanyProfileSuggestions

get_ai_form_suggestions_from_file

Schema: company

Type: Mutation

Returns: FormSuggestions

get_ai_form_suggestions_from_file(
  "Base64 data URL of the file, e.g. `data:application/pdf;base64,...` or `data:image/png;base64,...`. Accepts PDF, PNG, JPEG, GIF, WEBP up to 10 MB (decoded)."
  file_data_url: String!
): FormSuggestions

get_ai_form_suggestions_from_url

Schema: company

Type: Mutation

Returns: FormSuggestions

get_ai_form_suggestions_from_url(
  "URL of a page containing the form to analyze"
  url: String!
): FormSuggestions

get_ai_rcs_suggestions

Schema: company

Type: Mutation

Returns: RcsInformationSuggestions

get_ai_rcs_suggestions: RcsInformationSuggestions

import_users_from_csv

Schema: company

Type: Mutation

Returns: UserImport

import_users_from_csv(
  "The type of B2C connection to create for imported users (omit to skip)"
  b2c_type: B2cConnectionType
  "The type of C2C connection to create for imported users (omit to skip)"
  c2c_type: C2cConnectionType
  "The S3 file key from prepareFileUpload"
  file_key: String!
  "Internal note about this import"
  note: String
  "Request email subscription for imported users"
  request_email_subscription: Boolean
  "Request SMS subscription for imported users"
  request_sms_subscription: Boolean
  "Request voice subscription for imported users"
  request_voice_subscription: Boolean
): UserImport

leave_group

Schema: user

Type: Mutation

Returns: StatusResponse

leave_group(
  "Id of the group you want to leave"
  group_id: Id!
): StatusResponse

mark_all_notifications_as_read

Schema: user, company

Type: Mutation

Returns: StatusResponse

mark_all_notifications_as_read: StatusResponse

mark_notification_as_read

Schema: user, company

Type: Mutation

Returns: StatusResponse

mark_notification_as_read(
  "The ID of the notification to mark as read"
  id: Id!
): StatusResponse

mark_notifications_as_read

Schema: user, company

Type: Mutation

Returns: StatusResponse

mark_notifications_as_read(
  "The IDs of the notifications to mark as read"
  ids: [Id!]!
): StatusResponse

move_company_documents

Schema: company

Type: Mutation

Returns: BulkStatusResponse

move_company_documents(
  "Destination folder id; omit or pass null to move to the repository root"
  folder_id: Id
  "Ids of the documents to move"
  ids: [Id!]!
): BulkStatusResponse

move_company_folders

Schema: company

Type: Mutation

Returns: BulkStatusResponse

move_company_folders(
  "Ids of the folders to move"
  ids: [Id!]!
  "Destination folder id; omit or pass null to move to the repository root. A folder can't move into itself or one of its own descendants — those are skipped"
  parent_id: Id
): BulkStatusResponse

move_user_documents

Schema: user

Type: Mutation

Returns: BulkStatusResponse

move_user_documents(
  "Destination folder id; omit or pass null to move to the repository root"
  folder_id: Id
  "Ids of the documents to move"
  ids: [Id!]!
): BulkStatusResponse

move_user_folders

Schema: user

Type: Mutation

Returns: BulkStatusResponse

move_user_folders(
  "Ids of the folders to move"
  ids: [Id!]!
  "Destination folder id; omit or pass null to move to the repository root. A folder can't move into itself or one of its own descendants — those are skipped"
  parent_id: Id
): BulkStatusResponse

permanently_delete_company_documents

Schema: company

Type: Mutation

Returns: BulkStatusResponse

permanently_delete_company_documents(
  "Ids of the trashed documents to permanently delete"
  ids: [Id!]!
): BulkStatusResponse

permanently_delete_user_documents

Schema: user

Type: Mutation

Returns: BulkStatusResponse

permanently_delete_user_documents(
  "Ids of the trashed documents to permanently delete"
  ids: [Id!]!
): BulkStatusResponse

prepare_document_upload

Schema: user, company

Type: Mutation

Returns: DocumentUpload

prepare_document_upload(
  "The file size in bytes — checked against the repository size limit and the per-file limit, and pinned into the upload policy so a larger file is refused"
  byte_size: String!
  "The MIME content type of the file"
  content_type: String!
  "The original file name"
  file_name: String!
  "The folder to place the document in; omit for the repository root"
  folder_id: Id
): DocumentUpload

prepare_file_upload

Schema: user, company

Type: Mutation

Returns: FileUpload

prepare_file_upload(
  "The MIME content type of the file"
  content_type: String!
  "The original file name"
  file_name: String!
): FileUpload

publish_form_version

Schema: company

Type: Mutation

Returns: FormVersion

publish_form_version(
  "The ID of the form version"
  form_version_id: Id!
  "Whether to publish (true) or unpublish (false)"
  published: Boolean!
): FormVersion

register_and_submit_ten_dlc_brand

Schema: company

Type: Mutation

Returns: TenDlcBrand

register_and_submit_ten_dlc_brand(
  "Brand registration parameters"
  input: TenDlcRegisterBrandInput!
): TenDlcBrand

register_and_submit_ten_dlc_campaign

Schema: company

Type: Mutation

Returns: TenDlcCampaign

register_and_submit_ten_dlc_campaign(
  "Campaign registration parameters"
  input: TenDlcRegisterCampaignInput!
): TenDlcCampaign

register_ten_dlc_brand_as_draft

Schema: company

Type: Mutation

Returns: TenDlcBrand

register_ten_dlc_brand_as_draft(
  "Brand registration parameters"
  input: TenDlcRegisterBrandInput!
): TenDlcBrand

register_ten_dlc_campaign_when_ready

Schema: company

Type: Mutation

Returns: TenDlcCampaign

register_ten_dlc_campaign_when_ready(
  "Campaign registration parameters"
  input: TenDlcRegisterCampaignInput!
): TenDlcCampaign

reject_b2b_form_submission_request

Schema: company

Type: Mutation

Returns: StatusResponse

reject_b2b_form_submission_request(
  "The ID of the form submission request"
  id: Id!
): StatusResponse

reject_form_submission_request

Schema: user

Type: Mutation

Returns: StatusResponse

reject_form_submission_request(
  "The ID of the form submission request"
  id: Id!
): StatusResponse

remove_b2b_connection

Schema: company

Type: Mutation

Returns: B2bConnection

remove_b2b_connection(
  "Id of the connection you want to remove"
  connection_id: Id!
): B2bConnection

remove_b2c_connection

Schema: company

Type: Mutation

Returns: B2cConnection

remove_b2c_connection(
  "Id of the connection you want to remove"
  connection_id: Id!
): B2cConnection

remove_b2c_subscription

Schema: user, company

Type: Mutation

Returns: B2cSubscription

remove_b2c_subscription(
  "Id of the subscription you want to remove"
  subscription_id: Id!
): B2cSubscription

remove_b2c_subscription_topic

Schema: company

Type: Mutation

Returns: B2cSubscriptionTopic

remove_b2c_subscription_topic(
  "ID of the subscription topic"
  id: Id!
): B2cSubscriptionTopic

remove_c2b_connection

Schema: user

Type: Mutation

Returns: B2cConnection

remove_c2b_connection(
  "Id of the connection you want to remove"
  connection_id: Id!
): B2cConnection

remove_c2c_connection

Schema: user

Type: Mutation

Returns: C2cConnection

remove_c2c_connection(
  "Id of the connection you want to remove"
  connection_id: Id!
): C2cConnection

remove_company_address

Schema: company

Type: Mutation

Returns: Address

remove_company_address(
  "ID of the address"
  id: Id!
): Address

remove_company_document_tag

Schema: company

Type: Mutation

Returns: StatusResponse

remove_company_document_tag(
  "The document id"
  document_id: Id!
  "The tag id"
  tag_id: Id!
): StatusResponse

remove_company_email

Schema: company

Type: Mutation

Returns: Email

remove_company_email(
  "ID of the email"
  id: Id!
): Email

remove_company_telephone_number

Schema: company

Type: Mutation

Returns: TelephoneNumber

remove_company_telephone_number(
  "ID of the telephone number"
  id: Id!
): TelephoneNumber

remove_company_webhook

Schema: company

Type: Mutation

Returns: CompanyWebhook

remove_company_webhook(
  "ID of the webhook"
  id: Id!
): CompanyWebhook

remove_group_user_member

Schema: user

Type: Mutation

Returns: StatusResponse

remove_group_user_member(
  "Id of the group the membership belongs to"
  group_id: Id!
  "Id of the user being removed"
  user_id: Id!
): StatusResponse

remove_user_address

Schema: user

Type: Mutation

Returns: Address

remove_user_address(
  "ID of the address"
  id: Id!
): Address

remove_user_document_tag

Schema: user

Type: Mutation

Returns: StatusResponse

remove_user_document_tag(
  "The document id"
  document_id: Id!
  "The tag id"
  tag_id: Id!
): StatusResponse

remove_user_email

Schema: user

Type: Mutation

Returns: UserEmail

remove_user_email(
  "ID of the email"
  id: Id!
): UserEmail

remove_user_telephone_number

Schema: user

Type: Mutation

Returns: UserTelephoneNumber

remove_user_telephone_number(
  "ID of the telephone number"
  id: Id!
): UserTelephoneNumber

report_external_communication

Schema: company

Type: Mutation

Returns: StatusResponse

report_external_communication(
  "Direction of the external communication, is it inbound or outbound."
  direction: CommunicationDirection!
  "External message ID"
  external_message_id: String!
  "What is the sender address of the external communication (phone number, email, username, etc.)"
  host_address: String!
  "Textual part of the external communication."
  message_body: String!
  "Additional information"
  metadata: Json
  "What is the receiver address of the external communication (phone number, email, username, etc.)"
  remote_address: String!
  "Date and time (UTC) when the external communication was sent or received"
  timestamp: NaiveDatetime!
  "Type of the external communication, e.g. SMS, MMS"
  type: CommunicationType!
): StatusResponse

respond_b2b_connection_request

Schema: company

Type: Mutation

Returns: B2bConnectionRequest

respond_b2b_connection_request(
  "Id of the request you want to accept"
  request_id: Id!
  "Response to the request - accepted or rejected"
  response: ConnectionRequestResponse!
): B2bConnectionRequest

respond_b2c_connection_request

Schema: user

Type: Mutation

Returns: B2cConnectionRequest

respond_b2c_connection_request(
  "Id of the request you want to accept"
  request_id: Id!
  "Response to the request - accepted or rejected"
  response: ConnectionRequestResponse!
): B2cConnectionRequest

respond_b2c_subscription_request

Schema: user

Type: Mutation

Returns: B2cSubscriptionRequest

respond_b2c_subscription_request(
  "Email record to subscribe (email-channel requests). Overrides the pending record set at request creation."
  email_id: Id
  "Id of the request you want to accept"
  request_id: Id!
  "Response to the request - accepted or rejected"
  response: SubscriptionRequestResponse!
  "Telephone number record to subscribe (SMS/voice-channel requests). Overrides the pending record set at request creation."
  telephone_number_id: Id
): B2cSubscriptionRequest

respond_c2b_connection_request

Schema: company

Type: Mutation

Returns: C2bConnectionRequest

respond_c2b_connection_request(
  "Id of the request you want to accept"
  request_id: Id!
  "Response to the request - accepted or rejected"
  response: ConnectionRequestResponse!
): C2bConnectionRequest

respond_c2c_connection_request

Schema: user

Type: Mutation

Returns: C2cConnectionRequest

respond_c2c_connection_request(
  "Id of the request you want to accept"
  request_id: Id!
  "Response to the request - accepted or rejected"
  response: ConnectionRequestResponse!
): C2cConnectionRequest

respond_group_user_member_invite

Schema: user

Type: Mutation

Returns: GroupUserMemberInvite

respond_group_user_member_invite(
  "Id of the invite you want to respond to"
  invite_id: Id!
  "Response to the request - accepted or rejected"
  response: GroupInviteResponse!
): GroupUserMemberInvite

respond_group_user_member_join_request

Schema: user

Type: Mutation

Returns: GroupUserMemberJoinRequest

respond_group_user_member_join_request(
  "Id of the join request you want to respond to"
  join_request_id: Id!
  "Response to the request - accepted or rejected"
  response: GroupInviteResponse!
): GroupUserMemberJoinRequest

restore_company_documents

Schema: company

Type: Mutation

Returns: BulkStatusResponse

restore_company_documents(
  "Ids of the trashed documents to restore"
  ids: [Id!]!
): BulkStatusResponse

restore_user_documents

Schema: user

Type: Mutation

Returns: BulkStatusResponse

restore_user_documents(
  "Ids of the trashed documents to restore"
  ids: [Id!]!
): BulkStatusResponse

revoke_b2b_connection_request

Schema: company

Type: Mutation

Returns: B2bConnectionRequest

revoke_b2b_connection_request(
  "Id of the request you want to revoke"
  request_id: Id!
): B2bConnectionRequest

revoke_b2c_connection_request

Schema: company

Type: Mutation

Returns: B2cConnectionRequest

revoke_b2c_connection_request(
  "Id of the request you want to revoke"
  request_id: Id!
): B2cConnectionRequest

revoke_b2c_subscription_request

Schema: company

Type: Mutation

Returns: B2cSubscriptionRequest

revoke_b2c_subscription_request(
  "Id of the request you want to revoke"
  request_id: Id!
): B2cSubscriptionRequest

revoke_c2b_connection_request

Schema: user

Type: Mutation

Returns: C2bConnectionRequest

revoke_c2b_connection_request(
  "Id of the request you want to revoke"
  request_id: Id!
): C2bConnectionRequest

revoke_c2c_connection_request

Schema: user

Type: Mutation

Returns: C2cConnectionRequest

revoke_c2c_connection_request(
  "Id of the request you want to revoke"
  request_id: Id!
): C2cConnectionRequest

revoke_group_user_member_invite

Schema: user

Type: Mutation

Returns: GroupUserMemberInvite

revoke_group_user_member_invite(
  "Id of the invite you want to revoke"
  invite_id: Id!
): GroupUserMemberInvite

revoke_group_user_member_join_request

Schema: user

Type: Mutation

Returns: GroupUserMemberJoinRequest

revoke_group_user_member_join_request(
  "Id of the join request you want to revoke"
  join_request_id: Id!
): GroupUserMemberJoinRequest

revoke_ten_dlc_api_key_authorization

Schema: company

Type: Mutation

Returns: String

revoke_ten_dlc_api_key_authorization(
  "Authorization record ID to revoke"
  authorization_id: Uuid!
): String

run_company_ai_task

Schema: company

Type: Mutation

Returns: BulkStatusResponse

run_company_ai_task(
  "Documents to run against; they need not sit in the task's folders. Omitted, the run covers what the task watches — its folders and everything beneath them, or the whole repository when it runs on the root — which is nothing at all for a task that watches neither"
  ids: [Id!]
  task_id: Id!
): BulkStatusResponse

run_user_ai_task

Schema: user

Type: Mutation

Returns: BulkStatusResponse

run_user_ai_task(
  "Documents to run against; they need not sit in the task's folders. Omitted, the run covers what the task watches — its folders and everything beneath them, or the whole repository when it runs on the root — which is nothing at all for a task that watches neither"
  ids: [Id!]
  task_id: Id!
): BulkStatusResponse

save_ten_dlc_campaign_as_draft

Schema: company

Type: Mutation

Returns: TenDlcCampaign

save_ten_dlc_campaign_as_draft(
  "Campaign registration parameters"
  input: TenDlcRegisterCampaignInput!
): TenDlcCampaign

set_primary_user_email

Schema: user

Type: Mutation

Returns: UserEmail

set_primary_user_email(
  "ID of the email"
  id: Id!
): UserEmail

set_primary_user_telephone_number

Schema: user

Type: Mutation

Returns: UserTelephoneNumber

set_primary_user_telephone_number(
  "ID of the telephone number"
  id: Id!
): UserTelephoneNumber

setup_invitation_from_token

Schema: user

Type: Mutation

Returns: InvitationSetupResult

setup_invitation_from_token(
  "The invitation link token"
  token: String!
): InvitationSetupResult

update_and_submit_ten_dlc_brand

Schema: company

Type: Mutation

Returns: TenDlcBrand

update_and_submit_ten_dlc_brand(
  "Internal brand identifier (UUID)"
  id: Id!
  "Brand update parameters"
  input: TenDlcUpdateBrandInput!
): TenDlcBrand

update_and_submit_ten_dlc_campaign

Schema: company

Type: Mutation

Returns: TenDlcCampaign

update_and_submit_ten_dlc_campaign(
  "Internal campaign identifier (UUID)"
  id: Id!
  "Campaign update parameters"
  input: TenDlcUpdateCampaignInput!
): TenDlcCampaign

update_b2c_connection_notification_settings

Schema: user

Type: Mutation

Returns: B2cConnectionNotificationSettings

update_b2c_connection_notification_settings(
  "Whether to receive B2B connection request received emails"
  b2b_conn_request_received_email: Boolean
  "Whether to receive B2B connection request response emails"
  b2b_conn_request_response_email: Boolean
  "Whether to receive B2B form instance submission request received emails"
  b2b_form_instance_submission_request_received_email: Boolean
  "Whether to receive B2C connection request response emails"
  b2c_conn_request_response_email: Boolean
  "The ID of the B2C connection to update"
  b2c_connection_id: Id!
  "Whether to receive B2C subscription request response emails"
  b2c_sub_request_response_email: Boolean
  "Whether to receive C2B connection request received emails"
  c2b_conn_request_received_email: Boolean
  "Whether to receive company social network status change emails"
  company_social_network_status_change_email: Boolean
): B2cConnectionNotificationSettings

update_b2c_subscription_topic

Schema: company

Type: Mutation

Returns: B2cSubscriptionTopic

update_b2c_subscription_topic(
  description: String
  enable_email: Boolean
  enable_sms: Boolean
  enable_voice: Boolean
  "ID of the subscription topic"
  id: Id!
  "Unique name of the topic"
  name: String
  type: B2cSubscriptionTopicType
): B2cSubscriptionTopic

update_client_secret

Schema: company

Type: Mutation

Returns: ClientSecret

update_client_secret(
  "Updated description"
  description: String!
  "Id of the client secret to update"
  id: Id!
): ClientSecret

update_company

Schema: company

Type: Mutation

Returns: Company

update_company(
  "About us of the company"
  about_us: String
  "About us visibility of the company"
  about_us_visibility: [CompanyVisibilityType!]
  "Addresses of the company, replaces addresses as a whole."
  addresses: [CompanyAddressInput]
  "B2C relation visibility of the company"
  b2c_visibility: [CompanyVisibilityType!]
  "Brand name of the company"
  brand_name: String
  "Brand name visibility of the company"
  brand_name_visibility: [CompanyVisibilityType!]
  "Specialty ids of the company"
  company_specialties: [Id]
  "Email addresses of the company, replaces emails as a whole."
  emails: [CompanyEmailInput]
  "Legal name of the company"
  legal_name: String
  "Legal name visibility of the company"
  legal_name_visibility: [CompanyVisibilityType!]
  "Logo url of the company"
  logo_url: String
  "Logo url visibility of company"
  logo_url_visibility: [CompanyVisibilityType!]
  "Additional information"
  metadata: Json
  "Metadata visibility of the company"
  metadata_visibility: [CompanyVisibilityType!]
  "Organization type id of the company"
  organization_type_id: Id
  "Organization type visibility of the company"
  organization_type_visibility: [CompanyVisibilityType!]
  "Profile name of the company"
  profile_name: String
  "A key/value storage for private data"
  secret_storage: Json
  "Social media pages of the company, replaces social media pages as a whole."
  social_networks: [CompanySocialMediaInput]
  "Specialties visibility of the company"
  specialties_visibility: [CompanyVisibilityType!]
  "Subscription settings of the company"
  subscription_settings: CompanySubscriptionSettingsInput
  "Subscription topics of the company, subscription topics as a whole."
  subscription_topics: [B2cSubscriptionTopicInput]
  "Tax id of the company"
  tax_id: String
  "Tax id visibility of the company"
  tax_id_visibility: [CompanyVisibilityType!]
  "Tax IDs of the company (EIN, Sales Tax, etc.)"
  tax_ids: [CompanyTaxIdInput]
  "Telephone numbers of the company, replaces telephone numbers as a whole."
  telephone_numbers: [CompanyTelephoneNumberInput]
  "Trusted domains of the company"
  trusted_domains: [TrustedDomainInput]
  "Vertical type id of the company"
  vertical_type_id: Id
  "Vertical type visibility of the company"
  vertical_type_visibility: [CompanyVisibilityType!]
  "Webpages of the company, replaces webpages as a whole."
  webpages: [CompanyWebpageInput]
  "Year of foundation of the company"
  year_founded: Integer
  "Year of foundation visibility of the company"
  year_founded_visibility: [CompanyVisibilityType!]
): Company

update_company_address

Schema: company

Type: Mutation

Returns: Address

update_company_address(
  "City of the address"
  city: String
  "Country of the address"
  country: String
  "ID of the address"
  id: Id!
  "State of the address"
  state: String
  "Street of the address"
  street: String
  "Types of the address"
  types: [CompanyAddressType!]
  "Visibility of the address"
  visibility: [CompanyVisibilityType!]
  "Zip code of the address"
  zip_code: String
): Address

update_company_ai_task

Schema: company

Type: Mutation

Returns: AiTask

update_company_ai_task(
  "Replaces the folders this task watches; omit to leave them as they are, or pass an empty list to clear them"
  folder_ids: [Id!]
  id: Id!
  name: String
  "Replaces the existing shape entirely"
  output_shape: Json
  prompt: String
  "Watch the whole repository, whatever folders it holds now or later; turning this on clears the folders"
  run_on_root: Boolean
): AiTask

update_company_document

Schema: company

Type: Mutation

Returns: Document

update_company_document(
  "The new file name"
  file_name: String
  "The document id"
  id: Id!
  "The new summary"
  summary: String
): Document

update_company_email

Schema: company

Type: Mutation

Returns: Email

update_company_email(
  "ID of the email"
  id: Id!
  "Types of the email"
  types: [CompanyEmailType!]
  "Visibility of the email"
  visibility: [CompanyVisibilityType!]
): Email

update_company_folder

Schema: company

Type: Mutation

Returns: Folder

update_company_folder(
  "The folder id"
  id: Id!
  "The new folder name"
  name: String
): Folder

update_company_invitation_link

Schema: company

Type: Mutation

Returns: InvitationLink

update_company_invitation_link(
  "Allow subscribing without creating a TNID account"
  allow_anonymous_subscription: Boolean
  "Allow connecting user to the inviting user's personal connections"
  allow_user_connection: Boolean
  "B2C connection type for joining users"
  b2c_connection_type: B2cConnectionType
  "C2C connection type for joining users"
  c2c_connection_type: C2cConnectionType
  "The ID of the invitation link to update"
  id: Id!
  "Name for the invitation link"
  name: String
  "Request email subscription for joining users"
  request_email_subscription: Boolean
  "Request SMS subscription for joining users"
  request_sms_subscription: Boolean
  "Request voice subscription for joining users"
  request_voice_subscription: Boolean
): InvitationLink

update_company_settings

Schema: company

Type: Mutation

Returns: CompanySettings

update_company_settings(
  "About us visibility of the company"
  about_us_visibility: [CompanyVisibilityType!]
  "B2C relation visibility of the company"
  b2c_visibility: [CompanyVisibilityType!]
  "Brand name visibility of the company"
  brand_name_visibility: [CompanyVisibilityType!]
  "How the owner arranged their dashboard: which widgets are shown and in what order. An object holding an integer `version` and `widgets`, the widget ids in display order, up to 16 KB"
  dashboard_layout: Json
  "Legal name visibility of the company"
  legal_name_visibility: [CompanyVisibilityType!]
  "Logo url visibility of company"
  logo_url_visibility: [CompanyVisibilityType!]
  "Metadata visibility of the company"
  metadata_visibility: [CompanyVisibilityType!]
  "Organization type visibility of the company"
  organization_type_visibility: [CompanyVisibilityType!]
  secret_storage: Json
  "Specialties visibility of the company"
  specialties_visibility: [CompanyVisibilityType!]
  "Subscription settings of the company"
  subscription_settings: CompanySubscriptionSettingsInput
  trusted_domains: [TrustedDomainInput]
  "Vertical type visibility of the company"
  vertical_type_visibility: [CompanyVisibilityType!]
  "Year of foundation visibility of the company"
  year_founded_visibility: [CompanyVisibilityType!]
): CompanySettings

update_company_telephone_number

Schema: company

Type: Mutation

Returns: TelephoneNumber

update_company_telephone_number(
  "ID of the telephone number"
  id: Id!
  "Additional information"
  types: [CompanyTelephoneNumberType!]
  "Visibility of the telephone number"
  visibility: [CompanyVisibilityType!]
): TelephoneNumber

update_company_webhook

Schema: company

Type: Mutation

Returns: CompanyWebhook

update_company_webhook(
  "Whether webhook should be used for B2B connection request received event"
  b2b_connection_request_received_webhook: Boolean
  "Whether webhook should be used for B2B connection response received event"
  b2b_connection_request_response_webhook: Boolean
  "Whether webhook should be used for B2B form instance subsmission request received event"
  b2b_form_instance_submission_request_received_webhook: Boolean
  "Whether webhook should be used for B2C connection request response event"
  b2c_connection_request_response_webhook: Boolean
  "Whether webhook should be used for B2C subscription request response event"
  b2c_subscription_request_response_webhook: Boolean
  "Bearer token to be used with the webhook"
  bearer_token: String
  "Whether webhook should be used for C2B connection request received event"
  c2b_connection_request_received_webhook: Boolean
  "Whether webhook should be used for Company social network status change event"
  company_social_network_status_change_webhook: Boolean
  "Custom headers to be used with the webhook"
  custom_headers: Json
  "ID of the webhook"
  id: Id!
  "Name of the webhook"
  name: String
  "Whether webhook should be used for opt-out event"
  receive_opt_out_events: Boolean
  "Whether webhook should be used for subscription event"
  receive_subscription_events: Boolean
  "URL of the webhook"
  url: String
): CompanyWebhook

update_form

Schema: company

Type: Mutation

Returns: Form

update_form(
  "Description of the form"
  description: String
  "The ID of the form"
  form_id: Id!
  "Who the form is intended for"
  intended_for: [FormBuilderFormIntendedFor!]
  "Title of the form"
  title: String
  "Visibility settings"
  visibility: [FormBuilderFormVisibility!]
): Form

update_form_version

Schema: company

Type: Mutation

Returns: FormVersion

update_form_version(
  "Updated fields"
  fields: [FormVersionFieldInput!]!
  "The ID of the form"
  form_id: Id!
  "The ID of the form version to update"
  form_version_id: Id!
): FormVersion

update_group

Schema: user

Type: Mutation

Returns: Group

update_group(
  "Id of the Group that is to be updated"
  group_id: Id!
  "Logo url of the group"
  logo_url: String
  "Additional information"
  metadata: Json
  "Name of the group"
  name: String
  "A key/value storage for private data, only accessible to group members"
  secret_storage: Json
  "Visibility of the group"
  visibility: [GroupVisibilityType!]
): Group

update_group_notification_settings

Schema: user

Type: Mutation

Returns: GroupNotificationSettings

update_group_notification_settings(
  "The ID of the group user member to update settings for"
  group_user_member_id: Id!
  "Whether to receive email notifications for group user member join requests"
  group_user_member_join_request_received_email: Boolean
  "Whether to receive in-app notifications for group user member join requests"
  group_user_member_join_request_received_notification: Boolean
): GroupNotificationSettings

update_group_user_member_role

Schema: user

Type: Mutation

Returns: StatusResponse

update_group_user_member_role(
  "Id of the group the membership belongs to"
  group_id: Id!
  "New role for the membership"
  role: GroupRoleType!
  "Id of the user whose membership is being updated"
  user_id: Id!
): StatusResponse

update_notification_settings

Schema: user

Type: Mutation

Returns: UserNotificationSettings

update_notification_settings(
  "Receive email for company connection request received"
  b2c_conn_request_received_email: Boolean
  "Receive in-app notification for company connection request received"
  b2c_conn_request_received_notification: Boolean
  "Receive email for company form submission request received"
  b2c_form_instance_request_received_email: Boolean
  "Receive in-app notification for company form submission request received"
  b2c_form_instance_request_received_notification: Boolean
  "Receive email for company subscription request received"
  b2c_sub_request_received_email: Boolean
  "Receive in-app notification for company subscription request received"
  b2c_sub_request_received_notification: Boolean
  "Receive email for company connection request response received"
  c2b_conn_request_response_email: Boolean
  "Receive in-app notification for company connection request response received"
  c2b_conn_request_response_notification: Boolean
  "Receive email for people connection request received"
  c2c_conn_request_received_email: Boolean
  "Receive in-app notification for people connection request received"
  c2c_conn_request_received_notification: Boolean
  "Receive email for people connection request response received"
  c2c_conn_request_response_email: Boolean
  "Receive in-app notification for people connection request response received"
  c2c_conn_request_response_notification: Boolean
): UserNotificationSettings

update_ten_dlc_api_key

Schema: company

Type: Mutation

Returns: TenDlcApiKey

update_ten_dlc_api_key(
  "API Key ID to update"
  id: String!
  "Updated API Key name/label"
  name: String!
): TenDlcApiKey

update_ten_dlc_brand_as_draft

Schema: company

Type: Mutation

Returns: TenDlcBrand

update_ten_dlc_brand_as_draft(
  "Unique brand identifier"
  id: String!
  "Brand update parameters"
  input: TenDlcUpdateBrandInput!
): TenDlcBrand

update_ten_dlc_campaign_as_draft

Schema: company

Type: Mutation

Returns: TenDlcCampaign

update_ten_dlc_campaign_as_draft(
  "Internal campaign identifier (UUID)"
  id: Id!
  "Campaign update parameters"
  input: TenDlcUpdateCampaignInput!
): TenDlcCampaign

update_user

Schema: user

Type: Mutation

Returns: User

update_user(
  "About me of the user"
  about_me: String
  "About me visibility of the user"
  about_me_visibility: [UserVisibilityType!]
  "Addresses of the user, replaces addresses as a whole."
  addresses: [UserAddressInput]
  "Birthdate of the user"
  birthdate: Date
  "Birthday visibility of the user"
  birthdate_visibility: [UserVisibilityType!]
  "Email addresses of the user, replaces emails as a whole."
  emails: [UserEmailInput]
  "First name of the user"
  first_name: String
  "Interests visibility of the user"
  interests_visibility: [UserVisibilityType!]
  "Last name of the user"
  last_name: String
  "Additional information"
  metadata: Json
  "Metadata visibility of the user"
  metadata_visibility: [UserVisibilityType!]
  "Middle name of the user"
  middle_name: String
  "Name visibility of the user"
  name_visibility: [UserVisibilityType!]
  "Profile image url of the user"
  profile_image_url: String
  "Profile image url visibility of the user"
  profile_image_url_visibility: [UserVisibilityType!]
  "A key/value storage for private data"
  secret_storage: Json
  "Social media pages of the user, replaces social media pages as a whole."
  social_networks: [UserSocialMediaInput]
  "Telephone numbers of the user, replaces telephone numbers as a whole."
  telephone_numbers: [UserTelephoneNumberInput!]
  "Timezone of the user"
  timezone: String
  "Timezone visibility of the user"
  timezone_visibility: [UserVisibilityType!]
  "Interest ids of the user"
  user_interests: [Id]
  "Username of the user"
  username: String
  "Webpages of the user, replaces webpages as a whole."
  webpages: [UserWebpageInput]
): User

update_user_address

Schema: user

Type: Mutation

Returns: Address

update_user_address(
  "City of the address"
  city: String
  "Country of the address"
  country: String
  "ID of the address"
  id: Id!
  "State of the address"
  state: String
  "Street of the address"
  street: String
  "Types of the address"
  types: [UserAddressType!]
  "Visibility of the address"
  visibility: [UserVisibilityType!]
  "Zip code of the address"
  zip_code: String
): Address

update_user_ai_task

Schema: user

Type: Mutation

Returns: AiTask

update_user_ai_task(
  "Replaces the folders this task watches; omit to leave them as they are, or pass an empty list to clear them"
  folder_ids: [Id!]
  id: Id!
  name: String
  "Replaces the existing shape entirely"
  output_shape: Json
  prompt: String
  "Watch the whole repository, whatever folders it holds now or later; turning this on clears the folders"
  run_on_root: Boolean
): AiTask

update_user_document

Schema: user

Type: Mutation

Returns: Document

update_user_document(
  "The new file name"
  file_name: String
  "The document id"
  id: Id!
  "The new summary"
  summary: String
): Document

update_user_email

Schema: user

Type: Mutation

Returns: UserEmail

update_user_email(
  "ID of the email"
  id: Id!
  "Types of the email"
  types: [UserEmailType!]
  "Visibility of the email"
  visibility: [UserVisibilityType!]
): UserEmail

update_user_folder

Schema: user

Type: Mutation

Returns: Folder

update_user_folder(
  "The folder id"
  id: Id!
  "The new folder name"
  name: String
): Folder

update_user_settings

Schema: user

Type: Mutation

Returns: UserSettings

update_user_settings(
  "About me visibility of the user"
  about_me_visibility: [UserVisibilityType!]
  "Birthday visibility of the user"
  birthdate_visibility: [UserVisibilityType!]
  "How the owner arranged their dashboard: which widgets are shown and in what order. An object holding an integer `version` and `widgets`, the widget ids in display order, up to 16 KB"
  dashboard_layout: Json
  "Interests visibility of the user"
  interests_visibility: [UserVisibilityType!]
  "Metadata visibility of the user"
  metadata_visibility: [UserVisibilityType!]
  "Name visibility of the user"
  name_visibility: [UserVisibilityType!]
  "Profile image url visibility of the user"
  profile_image_url_visibility: [UserVisibilityType!]
  "A key/value storage for private data"
  secret_storage: Json
  "Timezone visibility of the user"
  timezone_visibility: [UserVisibilityType!]
): UserSettings

update_user_telephone_number

Schema: user

Type: Mutation

Returns: UserTelephoneNumber

update_user_telephone_number(
  "ID of the telephone number"
  id: Id!
  "Additional information"
  types: [UserTelephoneNumberType!]
  "Visibility of the telephone number"
  visibility: [UserVisibilityType!]
): UserTelephoneNumber

upsert_b2c_subscription

Schema: user

Type: Mutation

Returns: B2cSubscription

upsert_b2c_subscription(
  "Company ID the subscription belongs to"
  company_id: Id!
  "Email ID to use for email the subscription"
  email_id: Id
  "Date when the subscription should expire on"
  expiration_date: Date
  "End time of notifications for the subscription"
  notification_end_time: Time
  "Start time of notifications for the subscription"
  notification_start_time: Time
  "Topic IDs to subscribe to"
  subscription_topic_ids: [Id!]!
  "Telephone number ID to use for sms or voice the subscription"
  telephone_number_id: Id
  "Type of the subscription"
  type: B2cSubscriptionType!
): B2cSubscription

upsert_company_rcs_information

Schema: company

Type: Mutation

Returns: CompanyRcsInformation

upsert_company_rcs_information(
  "Description of the capabilities the agent advertises"
  agent_capabilities: String
  "Primary theme color in HEX format (e.g. #FF0000)"
  agent_color_schema_primary: String
  "Secondary theme color in HEX format (e.g. #00FF00)"
  agent_color_schema_secondary: String
  "Short description of the RCS agent (max 256 characters)"
  agent_description: String
  "URL of the agent logo (upload separately via prepareFileUpload, then pass the resulting URL here)"
  agent_logo_url: String
  "Display name of the RCS agent (max 40 characters)"
  agent_name: String
  "Region the agent will operate in"
  agent_region: String
  "Authorization contact created inline; pass when no existing contact applies (mutually exclusive with `authorization_contact_id`)"
  authorization_contact: RcsAuthorizationContactInput
  "ID of the user to list as the authorization contact for the agent registration"
  authorization_contact_id: Id
  "ISO country code where the company was incorporated"
  country_of_incorporation: String
  "Whether the agent supports rich media like images and video"
  rich_media_support: Boolean
  "Full list of actions to persist (replaces the existing list)"
  suggested_actions: [RcsSuggestedActionInput!]
  "Full list of quick replies to persist (replaces the existing list)"
  suggested_replies: [RcsSuggestedReplyInput!]
  "Welcome message shown when a user first opens a conversation (max 120 characters)"
  welcome_message: String
): CompanyRcsInformation

verify_company_email

Schema: company

Type: Mutation

Returns: StatusResponse

verify_company_email(
  "Verification code"
  code: String!
  "Id of the company email"
  email_id: Id!
): StatusResponse

verify_company_telephone_number

Schema: company

Type: Mutation

Returns: StatusResponse

verify_company_telephone_number(
  "Verification code"
  code: String!
  "Id of the company telephone number"
  telephone_number_id: Id!
): StatusResponse

verify_user_email

Schema: user

Type: Mutation

Returns: StatusResponse

verify_user_email(
  "Verification code"
  code: String!
  "Id of the email"
  email_id: Id!
): StatusResponse

verify_user_telephone_number

Schema: user

Type: Mutation

Returns: StatusResponse

verify_user_telephone_number(
  "Verification code"
  code: String!
  "Id of the telephone_numbe"
  telephone_number_id: Id!
): StatusResponse