Skip to main content

StarredCannedReply

A canned reply is a prewritten answer to commonly asked customer questions.

To fetch all canned replies:

query CannedReplies {
  cannedReplies {
    nodes {
      body
      category {
        id
      }
      createdAt
      creator {
        id
      }
      id
      name
      snippet
      subject
      updatedAt
      lastUsedAt
      countUsed
      attachments {
        id
      }
    }
  }
}

To fetch all canned replies with a given search string:

query CannedReplies {
  cannedReplies( filter: { keywords: "foo" } ) {
    nodes {
      id
      name
    }
  }
}

To fetch all canned replies with a given search string in a particular category:

query CannedReplies {
  cannedReplies( filter: { keywords: "foo", category_ids: [ "crc_123456" ] } ) {
    nodes {
      id
      name
    }
  }
}
type StarredCannedReply implements Node, Timestamped, Utilizationabled {
  attachments(
  after: String
  before: String
  first: Int
  last: Int
): AttachmentConnection!
  automaticActions: [CannedReplyAutomaticAction!]!
  body: String
  category: CannedReplyCategory
  countUsed: Int!
  createdAt: DateTime!
  creator: Agent
  id: ID!
  interpolatedBody(
  channelId: ID
  contactId: ID!
  conversationId: ID
  messageId: ID
): String
  lastUsedAt: DateTime
  mailboxIds: [String!]
  name: String
  snippet: String
  subject: String
  updatedAt: DateTime!
}

Fields​

StarredCannedReply.attachments ● AttachmentConnection! non-null object common​

All attachments on this canned reply.

StarredCannedReply.attachments.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

StarredCannedReply.attachments.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

StarredCannedReply.attachments.first ● Int scalar common​

Returns the first n elements from the list.

StarredCannedReply.attachments.last ● Int scalar common​

Returns the last n elements from the list.

StarredCannedReply.automaticActions ● [CannedReplyAutomaticAction!]! non-null object common​

All automatic actions set on this canned reply.

StarredCannedReply.body ● String scalar common​

The content of the canned reply template.

StarredCannedReply.category ● CannedReplyCategory object common​

The category of the canned reply.

StarredCannedReply.countUsed ● Int! non-null scalar common​

The number of times the object has been utilized.

StarredCannedReply.createdAt ● DateTime! non-null scalar common​

The date and time that the object was created.

StarredCannedReply.creator ● Agent object common​

The agent that created the canned reply.

StarredCannedReply.id ● ID! non-null scalar common​

StarredCannedReply.interpolatedBody ● String scalar common​

The content of the canned reply template with all variables interpolated.

StarredCannedReply.interpolatedBody.channelId ● ID scalar common​

The ID of the channel to use for interpolation.

StarredCannedReply.interpolatedBody.contactId ● ID! non-null scalar common​

The ID of the contact to use for interpolation.

StarredCannedReply.interpolatedBody.conversationId ● ID scalar common​

The ID of the conversation to use for interpolation.

StarredCannedReply.interpolatedBody.messageId ● ID scalar common​

The ID of the message to use for interpolation.

StarredCannedReply.lastUsedAt ● DateTime scalar common​

The date and time that the object was last used.

StarredCannedReply.mailboxIds ● [String!] list scalar common​

Searches for a mailbox that match the id.

StarredCannedReply.name ● String scalar common​

The name of the canned reply.

StarredCannedReply.snippet ● String scalar common​

A short snippet from the canned reply body.

StarredCannedReply.subject ● String scalar common​

The subject line of the canned reply.

StarredCannedReply.updatedAt ● DateTime! non-null scalar common​

The date and time that the object was last updated.

Interfaces​

Node interface common​

An object with an ID.

Timestamped interface common​

An object with timestamp fields for when it was created and last updated.

Utilizationabled interface common​

An object with utilization fields for when it was last used and how many times it has been used.

Member of​

StarredCannedReplyConnection object ● StarredCannedReplyCreatePayload object ● StarredCannedReplyEdge object