Skip to main content

folderUpdate

Updates an Inbox folder.

mutation(
  $folderId: ID!,
  $name: String!,
  $description: String,
  $matchType: FolderMatchTypes!,
  $state: FolderState!,
  $position: Int,
  $displayCountWhenInactive: Boolean,
  $hideIfZeroConversations: Boolean,
  $permittedAgentIds: [ID!],
  $permittedTeamIds: [ID!],
  $channelIds: [ID!],
  $conditions: [ConditionInput!]!
) {
  folderUpdate(
    input: {
      folderId: $folderId,
      name: $name,
      description: $description,
      matchType: $matchType,
      state: $state,
      position: $position,
      displayCountWhenInactive: $displayCountWhenInactive,
      hideIfZeroConversations: $hideIfZeroConversations,
      permittedAgentIds: $permittedAgentIds,
      permittedTeamIds: $permittedTeamIds,
      channelIds: $channelIds,
      conditions: $conditions
    }
  ) {
    folder {
      id
      name
    }
    errors {
      path
      message
    }
  }
}
folderUpdate(
  input: FolderUpdateInput!
): FolderUpdatePayload

Arguments​

folderUpdate.input ● FolderUpdateInput! non-null input common​

Parameters for FolderUpdate

Type​

FolderUpdatePayload object common​

Autogenerated return type of FolderUpdate