OBJECT

Campaign

Marketing campaign (email/sms) sent to clients by provider

link GraphQL Schema definition

  • type Campaign {
  • # Button label in email
  • button_text: String
  • # URL in button
  • button_url: String
  • # individual clients who have received this campaign
  • #
  • # Arguments
  • # offset: the page offset (if should paginate)
  • # should_paginate: if the result should be paginated
  • clients(offset: Int, should_paginate: Boolean): [User!]
  • # Email body
  • email_body: String
  • # Greeting used before email body
  • email_greeting: String
  • # Subject line of email
  • email_subject: String
  • # The unique identifier of the campaign
  • id: ID!
  • # If true, campaign hasn't been sent and has been saved as a draft
  • is_draft: Boolean
  • # If true, campaign (will be/has been) sent as an email
  • is_email: Boolean!
  • # If true, campaign (will be/has been) sent as an sms message
  • is_sms: Boolean!
  • # Name of a campaign labeled by provider
  • name: String
  • # SMS text message content
  • sms_body: String
  • # Groups of users with the same tags who have received this campaign
  • tags: [Tag!]
  • # Name of a campaign labeled by provider
  • user: User
  • # User groups who have received this campaign
  • user_groups: [UserGroup!]
  • }