INFOMAIL - GraphQL API Reference

Welcome to the GraphQL API Reference of Infomail application! This reference includes the complete set of GraphQL types, queries, mutations and their parameters of Infomail's GraphQL APIs.

Contact

API Support

assistenza@infomail.it

API Endpoints

https://graphql.k8s.ifm.infomail.it/graphql

Headers

# Your API JWT token returned by the login API. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>

Version

1.0.0

Queries

`account`

Response

Returns an Account!

Example

Query

query account {
  account {
    uniqueId
    credits
    creditsExpirationDate
    maxSendMonth
    maxSendDay
    countContacts
    sentTotal
    sentEmailInCurrentMonth
    sentEmailInCurrentDay
    planType
    plan
    email
    personal
  }
}

Response

{
  "data": {
    "account": {
      "uniqueId": "xyz789",
      "credits": 123,
      "creditsExpirationDate": "2007-12-03",
      "maxSendMonth": 987,
      "maxSendDay": 123,
      "countContacts": 123,
      "sentTotal": 123,
      "sentEmailInCurrentMonth": 987,
      "sentEmailInCurrentDay": 987,
      "planType": "consumable",
      "plan": "TRIAL",
      "email": "abc123",
      "personal": "xyz789"
    }
  }
}

Queries

`email`

Response

Returns an Email

Arguments

Name	Description
`id` - `Int!`
`emailSetId` - `Int!`

Example

Query

query email(
  $id: Int!,
  $emailSetId: Int!
) {
  email(
    id: $id,
    emailSetId: $emailSetId
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"id": 123, "emailSetId": 123}

Response

{
  "data": {
    "email": {
      "id": 123,
      "email": "xyz789",
      "idUnique": "xyz789",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["xyz789"],
      "optionalFields": [EmailField]
    }
  }
}

Queries

`emailset`

Response

Returns an EmailSet

Arguments

Name	Description
`id` - `Int!`

Example

Query

query emailset($id: Int!) {
  emailset(id: $id) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"id": 987}

Response

{
  "data": {
    "emailset": {
      "id": 987,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "abc123",
      "comment": "xyz789",
      "emailnumber": 987,
      "type": "T",
      "uploadStatus": 987,
      "customFields": [CustomField],
      "tags": ["abc123"],
      "segments": [Segment],
      "formToken": "abc123"
    }
  }
}

Queries

`getAccount`

Response

Returns an Account!

Arguments

Name	Description
`uid` - `String!`

Example

Query

query getAccount($uid: String!) {
  getAccount(uid: $uid) {
    uniqueId
    credits
    creditsExpirationDate
    maxSendMonth
    maxSendDay
    countContacts
    sentTotal
    sentEmailInCurrentMonth
    sentEmailInCurrentDay
    planType
    plan
    email
    personal
  }
}

Variables

{"uid": "xyz789"}

Response

{
  "data": {
    "getAccount": {
      "uniqueId": "abc123",
      "credits": 987,
      "creditsExpirationDate": "2007-12-03",
      "maxSendMonth": 987,
      "maxSendDay": 987,
      "countContacts": 987,
      "sentTotal": 987,
      "sentEmailInCurrentMonth": 123,
      "sentEmailInCurrentDay": 987,
      "planType": "consumable",
      "plan": "TRIAL",
      "email": "xyz789",
      "personal": "xyz789"
    }
  }
}

Queries

`getAccounts`

Response

Returns an AccountsPaginated!

Arguments

Name	Description
`input` - `GetAccountsInput!`

Example

Query

query getAccounts($input: GetAccountsInput!) {
  getAccounts(input: $input) {
    nodes {
      uniqueId
      credits
      creditsExpirationDate
      maxSendMonth
      maxSendDay
      countContacts
      sentTotal
      sentEmailInCurrentMonth
      sentEmailInCurrentDay
      planType
      plan
      email
      personal
    }
    total
    limit
    offset
  }
}

Variables

{"input": GetAccountsInput}

Response

{
  "data": {
    "getAccounts": {
      "nodes": [Account],
      "total": 123,
      "limit": 123,
      "offset": 123
    }
  }
}

Queries

`getBannedEmails`

Response

Returns a BannedEmailsPaginated!

Arguments

Name	Description
`input` - `GetBannedEmailsInput!`

Example

Query

query getBannedEmails($input: GetBannedEmailsInput!) {
  getBannedEmails(input: $input) {
    nodes {
      id
      email
      type
      bannedTime
      emailsetName
      newsletterId
      newsletterTitle
    }
    total
    limit
    offset
  }
}

Variables

{"input": GetBannedEmailsInput}

Response

{
  "data": {
    "getBannedEmails": {
      "nodes": [BannedEmail],
      "total": 987,
      "limit": 987,
      "offset": 987
    }
  }
}

Queries

`getDetailedStats`

Response

Returns a DetailedStats

Arguments

Name	Description
`email` - `String`
`id` - `String`

Example

Query

query getDetailedStats(
  $email: String,
  $id: String
) {
  getDetailedStats(
    email: $email,
    id: $id
  ) {
    result
  }
}

Variables

{
  "email": "abc123",
  "id": "abc123"
}

Response

{
  "data": {
    "getDetailedStats": {"result": "abc123"}
  }
}

Queries

`getEmailSets`

Response

Returns an EmailSetsPaginated!

Arguments

Name	Description
`input` - `GetEmailSetsInput!`

Example

Query

query getEmailSets($input: GetEmailSetsInput!) {
  getEmailSets(input: $input) {
    nodes {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    total
    limit
    offset
  }
}

Variables

{"input": GetEmailSetsInput}

Response

{
  "data": {
    "getEmailSets": {
      "nodes": [EmailSet],
      "total": 123,
      "limit": 123,
      "offset": 123
    }
  }
}

Queries

`getEmails`

Response

Returns an EmailsPaginated!

Arguments

Name	Description
`emailSetID` - `Int!`
`input` - `GetEmailsInput!`

Example

Query

query getEmails(
  $emailSetID: Int!,
  $input: GetEmailsInput!
) {
  getEmails(
    emailSetID: $emailSetID,
    input: $input
  ) {
    nodes {
      id
      email
      idUnique
      blocked
      subscribeTime
      unsubscribeTime
      tags
      optionalFields {
        ...EmailFieldFragment
      }
    }
    total
    limit
    offset
  }
}

Variables

{"emailSetID": 987, "input": GetEmailsInput}

Response

{
  "data": {
    "getEmails": {
      "nodes": [Email],
      "total": 987,
      "limit": 987,
      "offset": 987
    }
  }
}

Queries

`getNewsletters`

Response

Returns a NewslettersPaginated!

Arguments

Name	Description
`input` - `GetNewslettersInput!`

Example

Query

query getNewsletters($input: GetNewslettersInput!) {
  getNewsletters(input: $input) {
    nodes {
      id
      title
      creationTime
      comment
      sender {
        ...SenderFragment
      }
      subject
      preview
      status
      html
      template
      scheduledTime
      emailset {
        ...EmailSetFragment
      }
      segment {
        ...SegmentFragment
      }
      stats {
        ...NewsletterStatsFragment
      }
      canSend
      canSendTest
    }
    total
    limit
    offset
  }
}

Variables

{"input": GetNewslettersInput}

Response

{
  "data": {
    "getNewsletters": {
      "nodes": [Newsletter],
      "total": 123,
      "limit": 123,
      "offset": 123
    }
  }
}

Queries

`getPersonalities`

Response

Returns [Personality!]!

Arguments

Name	Description
`input` - `GetPersonalitiesInput!`

Example

Query

query getPersonalities($input: GetPersonalitiesInput!) {
  getPersonalities(input: $input) {
    id
    email
    name
    validated
  }
}

Variables

{"input": GetPersonalitiesInput}

Response

{
  "data": {
    "getPersonalities": [
      {
        "id": 987,
        "email": "abc123",
        "name": "xyz789",
        "validated": false
      }
    ]
  }
}

Queries

`getTemplates`

Response

Returns [Template]!

Arguments

Name	Description
`input` - `GetTemplatesInput`

Example

Query

query getTemplates($input: GetTemplatesInput) {
  getTemplates(input: $input) {
    id
    name
    html
    type
  }
}

Variables

{"input": GetTemplatesInput}

Response

{
  "data": {
    "getTemplates": [
      {
        "id": 4,
        "name": "abc123",
        "html": "abc123",
        "type": "ALL"
      }
    ]
  }
}

Queries

`getTestEmailSet`

Response

Returns an EmailSet!

Example

Query

query getTestEmailSet {
  getTestEmailSet {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Response

{
  "data": {
    "getTestEmailSet": {
      "id": 123,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "abc123",
      "comment": "xyz789",
      "emailnumber": 123,
      "type": "T",
      "uploadStatus": 987,
      "customFields": [CustomField],
      "tags": ["abc123"],
      "segments": [Segment],
      "formToken": "xyz789"
    }
  }
}

Queries

`newsletter`

Response

Returns a Newsletter

Arguments

Name	Description
`id` - `ID!`

Example

Query

query newsletter($id: ID!) {
  newsletter(id: $id) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "newsletter": {
      "id": 4,
      "title": "abc123",
      "creationTime": "2007-12-03",
      "comment": "xyz789",
      "sender": Sender,
      "subject": "abc123",
      "preview": "abc123",
      "status": "xyz789",
      "html": "xyz789",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": false
    }
  }
}

Queries

`template`

Response

Returns a Template

Arguments

Name	Description
`id` - `String!`

Example

Query

query template($id: String!) {
  template(id: $id) {
    id
    name
    html
    type
  }
}

Variables

{"id": "xyz789"}

Response

{
  "data": {
    "template": {
      "id": 4,
      "name": "xyz789",
      "html": "abc123",
      "type": "ALL"
    }
  }
}

Mutations

`addCustomField`

Response

Returns an EmailSet!

Arguments

Name	Description
`id` - `Int!`
`input` - `AddCustomFieldInput!`

Example

Query

mutation addCustomField(
  $id: Int!,
  $input: AddCustomFieldInput!
) {
  addCustomField(
    id: $id,
    input: $input
  ) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"id": 123, "input": AddCustomFieldInput}

Response

{
  "data": {
    "addCustomField": {
      "id": 123,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "xyz789",
      "comment": "xyz789",
      "emailnumber": 987,
      "type": "T",
      "uploadStatus": 987,
      "customFields": [CustomField],
      "tags": ["abc123"],
      "segments": [Segment],
      "formToken": "abc123"
    }
  }
}

Mutations

`addTagsToEmails`

Response

Returns [Int!]!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idEmails` - `[Int!]!`
`tags` - `[String!]!`

Example

Query

mutation addTagsToEmails(
  $idEmailSet: Int!,
  $idEmails: [Int!]!,
  $tags: [String!]!
) {
  addTagsToEmails(
    idEmailSet: $idEmailSet,
    idEmails: $idEmails,
    tags: $tags
  )
}

Variables

{
  "idEmailSet": 123,
  "idEmails": [987],
  "tags": ["abc123"]
}

Response

{"data": {"addTagsToEmails": [987]}}

Mutations

`banEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idEmail` - `Int!`

Example

Query

mutation banEmail(
  $idEmailSet: Int!,
  $idEmail: Int!
) {
  banEmail(
    idEmailSet: $idEmailSet,
    idEmail: $idEmail
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 987, "idEmail": 123}

Response

{
  "data": {
    "banEmail": {
      "id": 123,
      "email": "xyz789",
      "idUnique": "abc123",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["xyz789"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`blockEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idEmail` - `Int!`

Example

Query

mutation blockEmail(
  $idEmailSet: Int!,
  $idEmail: Int!
) {
  blockEmail(
    idEmailSet: $idEmailSet,
    idEmail: $idEmail
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 123, "idEmail": 123}

Response

{
  "data": {
    "blockEmail": {
      "id": 123,
      "email": "abc123",
      "idUnique": "abc123",
      "blocked": "abc123",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["xyz789"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`createEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`input` - `CreateEmailInput!`

Example

Query

mutation createEmail(
  $idEmailSet: Int!,
  $input: CreateEmailInput!
) {
  createEmail(
    idEmailSet: $idEmailSet,
    input: $input
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 123, "input": CreateEmailInput}

Response

{
  "data": {
    "createEmail": {
      "id": 987,
      "email": "xyz789",
      "idUnique": "xyz789",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["abc123"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`createEmailSet`

Response

Returns an EmailSet!

Arguments

Name	Description
`input` - `CreateEmailSetInput!`

Example

Query

mutation createEmailSet($input: CreateEmailSetInput!) {
  createEmailSet(input: $input) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"input": CreateEmailSetInput}

Response

{
  "data": {
    "createEmailSet": {
      "id": 987,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "xyz789",
      "comment": "xyz789",
      "emailnumber": 123,
      "type": "T",
      "uploadStatus": 987,
      "customFields": [CustomField],
      "tags": ["xyz789"],
      "segments": [Segment],
      "formToken": "abc123"
    }
  }
}

Mutations

`createNewsletter`

Response

Returns a Newsletter!

Arguments

Name	Description
`input` - `CreateNewsletterInput!`

Example

Query

mutation createNewsletter($input: CreateNewsletterInput!) {
  createNewsletter(input: $input) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"input": CreateNewsletterInput}

Response

{
  "data": {
    "createNewsletter": {
      "id": 4,
      "title": "xyz789",
      "creationTime": "2007-12-03",
      "comment": "xyz789",
      "sender": Sender,
      "subject": "xyz789",
      "preview": "abc123",
      "status": "xyz789",
      "html": "xyz789",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": true
    }
  }
}

Mutations

`createOrUpdateEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`input` - `CreateOrUpdateEmailInput!`

Example

Query

mutation createOrUpdateEmail(
  $idEmailSet: Int!,
  $input: CreateOrUpdateEmailInput!
) {
  createOrUpdateEmail(
    idEmailSet: $idEmailSet,
    input: $input
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 987, "input": CreateOrUpdateEmailInput}

Response

{
  "data": {
    "createOrUpdateEmail": {
      "id": 987,
      "email": "abc123",
      "idUnique": "abc123",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["xyz789"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`createPersonality`

Response

Returns a Personality!

Arguments

Name	Description
`input` - `CreatePersonalityInput!`

Example

Query

mutation createPersonality($input: CreatePersonalityInput!) {
  createPersonality(input: $input) {
    id
    email
    name
    validated
  }
}

Variables

{"input": CreatePersonalityInput}

Response

{
  "data": {
    "createPersonality": {
      "id": 123,
      "email": "xyz789",
      "name": "xyz789",
      "validated": true
    }
  }
}

Mutations

`createSegment`

Response

Returns a Segment!

Arguments

Name	Description
`idEmailSet` - `Int!`
`input` - `CreateSegmentInput!`

Example

Query

mutation createSegment(
  $idEmailSet: Int!,
  $input: CreateSegmentInput!
) {
  createSegment(
    idEmailSet: $idEmailSet,
    input: $input
  ) {
    id
    tags
    rule
    name
  }
}

Variables

{"idEmailSet": 987, "input": CreateSegmentInput}

Response

{
  "data": {
    "createSegment": {
      "id": 123,
      "tags": ["xyz789"],
      "rule": "AND",
      "name": "abc123"
    }
  }
}

Mutations

`deleteEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idEmail` - `Int!`

Example

Query

mutation deleteEmail(
  $idEmailSet: Int!,
  $idEmail: Int!
) {
  deleteEmail(
    idEmailSet: $idEmailSet,
    idEmail: $idEmail
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 123, "idEmail": 987}

Response

{
  "data": {
    "deleteEmail": {
      "id": 123,
      "email": "abc123",
      "idUnique": "xyz789",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["xyz789"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`deleteEmailByEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`email` - `String!`

Example

Query

mutation deleteEmailByEmail(
  $idEmailSet: Int!,
  $email: String!
) {
  deleteEmailByEmail(
    idEmailSet: $idEmailSet,
    email: $email
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 987, "email": "abc123"}

Response

{
  "data": {
    "deleteEmailByEmail": {
      "id": 987,
      "email": "abc123",
      "idUnique": "abc123",
      "blocked": "abc123",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["abc123"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`deleteEmailSet`

Response

Returns an EmailSet!

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation deleteEmailSet($id: Int!) {
  deleteEmailSet(id: $id) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"id": 987}

Response

{
  "data": {
    "deleteEmailSet": {
      "id": 987,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "xyz789",
      "comment": "xyz789",
      "emailnumber": 123,
      "type": "T",
      "uploadStatus": 123,
      "customFields": [CustomField],
      "tags": ["abc123"],
      "segments": [Segment],
      "formToken": "xyz789"
    }
  }
}

Mutations

`deleteNewsletter`

Response

Returns a Newsletter!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation deleteNewsletter($id: ID!) {
  deleteNewsletter(id: $id) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "deleteNewsletter": {
      "id": "4",
      "title": "abc123",
      "creationTime": "2007-12-03",
      "comment": "abc123",
      "sender": Sender,
      "subject": "abc123",
      "preview": "xyz789",
      "status": "xyz789",
      "html": "abc123",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": true,
      "canSendTest": false
    }
  }
}

Mutations

`deletePersonality`

Response

Returns a Personality!

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation deletePersonality($id: Int!) {
  deletePersonality(id: $id) {
    id
    email
    name
    validated
  }
}

Variables

{"id": 123}

Response

{
  "data": {
    "deletePersonality": {
      "id": 987,
      "email": "xyz789",
      "name": "xyz789",
      "validated": true
    }
  }
}

Mutations

`duplicateNewsletter`

Response

Returns a Newsletter!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation duplicateNewsletter($id: ID!) {
  duplicateNewsletter(id: $id) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "duplicateNewsletter": {
      "id": "4",
      "title": "xyz789",
      "creationTime": "2007-12-03",
      "comment": "xyz789",
      "sender": Sender,
      "subject": "abc123",
      "preview": "xyz789",
      "status": "xyz789",
      "html": "abc123",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": false
    }
  }
}

Mutations

`editCustomField`

Response

Returns an EmailSet!

Arguments

Name	Description
`id` - `Int!`
`idField` - `String!`
`input` - `EditCustomFieldInput!`

Example

Query

mutation editCustomField(
  $id: Int!,
  $idField: String!,
  $input: EditCustomFieldInput!
) {
  editCustomField(
    id: $id,
    idField: $idField,
    input: $input
  ) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{
  "id": 123,
  "idField": "xyz789",
  "input": EditCustomFieldInput
}

Response

{
  "data": {
    "editCustomField": {
      "id": 123,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "abc123",
      "comment": "xyz789",
      "emailnumber": 123,
      "type": "T",
      "uploadStatus": 123,
      "customFields": [CustomField],
      "tags": ["xyz789"],
      "segments": [Segment],
      "formToken": "xyz789"
    }
  }
}

Mutations

`editPersonality`

Response

Returns a Personality!

Arguments

Name	Description
`id` - `Int!`
`input` - `EditPersonalityInput!`

Example

Query

mutation editPersonality(
  $id: Int!,
  $input: EditPersonalityInput!
) {
  editPersonality(
    id: $id,
    input: $input
  ) {
    id
    email
    name
    validated
  }
}

Variables

{"id": 123, "input": EditPersonalityInput}

Response

{
  "data": {
    "editPersonality": {
      "id": 987,
      "email": "abc123",
      "name": "abc123",
      "validated": true
    }
  }
}

Mutations

`editSegment`

Response

Returns a Segment!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idSegment` - `Int!`
`input` - `EditSegmentInput!`

Example

Query

mutation editSegment(
  $idEmailSet: Int!,
  $idSegment: Int!,
  $input: EditSegmentInput!
) {
  editSegment(
    idEmailSet: $idEmailSet,
    idSegment: $idSegment,
    input: $input
  ) {
    id
    tags
    rule
    name
  }
}

Variables

{
  "idEmailSet": 987,
  "idSegment": 123,
  "input": EditSegmentInput
}

Response

{
  "data": {
    "editSegment": {
      "id": 123,
      "tags": ["abc123"],
      "rule": "AND",
      "name": "abc123"
    }
  }
}

Mutations

`exportEmailSet`

Response

Returns a String!

Arguments

Name	Description
`id` - `Int!`

Example

Query

mutation exportEmailSet($id: Int!) {
  exportEmailSet(id: $id)
}

Variables

{"id": 987}

Response

{"data": {"exportEmailSet": "xyz789"}}

Mutations

`generateAccountLoginToken`

Response

Returns a String!

Arguments

Name	Description
`uid` - `String!`

Example

Query

mutation generateAccountLoginToken($uid: String!) {
  generateAccountLoginToken(uid: $uid)
}

Variables

{"uid": "xyz789"}

Response

{
  "data": {
    "generateAccountLoginToken": "abc123"
  }
}

Mutations

`loadZipNewsletter`

Response

Returns a Newsletter

Arguments

Name	Description
`id` - `ID!`
`input` - `LoadZipInput!`

Example

Query

mutation loadZipNewsletter(
  $id: ID!,
  $input: LoadZipInput!
) {
  loadZipNewsletter(
    id: $id,
    input: $input
  ) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4, "input": LoadZipInput}

Response

{
  "data": {
    "loadZipNewsletter": {
      "id": 4,
      "title": "abc123",
      "creationTime": "2007-12-03",
      "comment": "abc123",
      "sender": Sender,
      "subject": "abc123",
      "preview": "abc123",
      "status": "abc123",
      "html": "abc123",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": true,
      "canSendTest": false
    }
  }
}

Mutations

`login`

Response

Returns an AuthUser!

Arguments

Name	Description
`input` - `LoginInput!`

Example

Query

mutation login($input: LoginInput!) {
  login(input: $input) {
    token
    uniqueId
    email
  }
}

Variables

{"input": LoginInput}

Response

{
  "data": {
    "login": {
      "token": "xyz789",
      "uniqueId": "xyz789",
      "email": "xyz789"
    }
  }
}

Mutations

`parseEmailSetCSV`

Response

Returns an ParseEmailSetCSVData!

Arguments

Name	Description
`url` - `String!`
`count` - `Int!`

Example

Query

mutation parseEmailSetCSV(
  $url: String!,
  $count: Int!
) {
  parseEmailSetCSV(
    url: $url,
    count: $count
  ) {
    rowCount
    examples
    separator
  }
}

Variables

{"url": "xyz789", "count": 987}

Response

{
  "data": {
    "parseEmailSetCSV": {
      "rowCount": 123,
      "examples": ["xyz789"],
      "separator": "xyz789"
    }
  }
}

Mutations

`removeCustomField`

Response

Returns an EmailSet!

Arguments

Name	Description
`id` - `Int!`
`idField` - `String!`

Example

Query

mutation removeCustomField(
  $id: Int!,
  $idField: String!
) {
  removeCustomField(
    id: $id,
    idField: $idField
  ) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"id": 987, "idField": "abc123"}

Response

{
  "data": {
    "removeCustomField": {
      "id": 987,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "xyz789",
      "comment": "xyz789",
      "emailnumber": 123,
      "type": "T",
      "uploadStatus": 123,
      "customFields": [CustomField],
      "tags": ["xyz789"],
      "segments": [Segment],
      "formToken": "xyz789"
    }
  }
}

Mutations

`scheduleNewsletter`

Response

Returns a Newsletter!

Arguments

Name	Description
`id` - `ID!`
`input` - `ScheduleNewsletterInput!`

Example

Query

mutation scheduleNewsletter(
  $id: ID!,
  $input: ScheduleNewsletterInput!
) {
  scheduleNewsletter(
    id: $id,
    input: $input
  ) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4, "input": ScheduleNewsletterInput}

Response

{
  "data": {
    "scheduleNewsletter": {
      "id": 4,
      "title": "abc123",
      "creationTime": "2007-12-03",
      "comment": "abc123",
      "sender": Sender,
      "subject": "xyz789",
      "preview": "abc123",
      "status": "abc123",
      "html": "abc123",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": true
    }
  }
}

Mutations

`startCSVUpload`

Response

Returns an EmailSet!

Arguments

Name	Description
`id` - `Int!`
`input` - `StartCSVUploadInput!`

Example

Query

mutation startCSVUpload(
  $id: Int!,
  $input: StartCSVUploadInput!
) {
  startCSVUpload(
    id: $id,
    input: $input
  ) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"id": 123, "input": StartCSVUploadInput}

Response

{
  "data": {
    "startCSVUpload": {
      "id": 123,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "xyz789",
      "comment": "xyz789",
      "emailnumber": 987,
      "type": "T",
      "uploadStatus": 987,
      "customFields": [CustomField],
      "tags": ["xyz789"],
      "segments": [Segment],
      "formToken": "abc123"
    }
  }
}

Mutations

`testNewsletter`

Response

Returns a Newsletter!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation testNewsletter($id: ID!) {
  testNewsletter(id: $id) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "testNewsletter": {
      "id": 4,
      "title": "abc123",
      "creationTime": "2007-12-03",
      "comment": "abc123",
      "sender": Sender,
      "subject": "abc123",
      "preview": "abc123",
      "status": "abc123",
      "html": "abc123",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": true
    }
  }
}

Mutations

`transactionalEmail`

Response

Returns a TransactionalEmail

Arguments

Name	Description
`input` - `TransactionalEmailInput!`

Example

Query

mutation transactionalEmail($input: TransactionalEmailInput!) {
  transactionalEmail(input: $input) {
    email
    messageSentId
    status
  }
}

Variables

{"input": TransactionalEmailInput}

Response

{
  "data": {
    "transactionalEmail": {
      "email": "xyz789",
      "messageSentId": "xyz789",
      "status": "abc123"
    }
  }
}

Mutations

`unBanEmail`

Response

Returns a BannedEmail!

Arguments

Name	Description
`email` - `String!`

Example

Query

mutation unBanEmail($email: String!) {
  unBanEmail(email: $email) {
    id
    email
    type
    bannedTime
    emailsetName
    newsletterId
    newsletterTitle
  }
}

Variables

{"email": "xyz789"}

Response

{
  "data": {
    "unBanEmail": {
      "id": 987,
      "email": "abc123",
      "type": "A",
      "bannedTime": "2007-12-03",
      "emailsetName": "xyz789",
      "newsletterId": 987,
      "newsletterTitle": "abc123"
    }
  }
}

Mutations

`unBlockEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idEmail` - `Int!`

Example

Query

mutation unBlockEmail(
  $idEmailSet: Int!,
  $idEmail: Int!
) {
  unBlockEmail(
    idEmailSet: $idEmailSet,
    idEmail: $idEmail
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{"idEmailSet": 123, "idEmail": 123}

Response

{
  "data": {
    "unBlockEmail": {
      "id": 987,
      "email": "xyz789",
      "idUnique": "xyz789",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["abc123"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`unscheduleNewsletter`

Response

Returns a Newsletter!

Arguments

Name	Description
`id` - `ID!`

Example

Query

mutation unscheduleNewsletter($id: ID!) {
  unscheduleNewsletter(id: $id) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4}

Response

{
  "data": {
    "unscheduleNewsletter": {
      "id": "4",
      "title": "abc123",
      "creationTime": "2007-12-03",
      "comment": "xyz789",
      "sender": Sender,
      "subject": "abc123",
      "preview": "abc123",
      "status": "xyz789",
      "html": "xyz789",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": false
    }
  }
}

Mutations

`updateEmail`

Response

Returns an Email!

Arguments

Name	Description
`idEmailSet` - `Int!`
`idEmail` - `Int!`
`input` - `UpdateEmailInput!`

Example

Query

mutation updateEmail(
  $idEmailSet: Int!,
  $idEmail: Int!,
  $input: UpdateEmailInput!
) {
  updateEmail(
    idEmailSet: $idEmailSet,
    idEmail: $idEmail,
    input: $input
  ) {
    id
    email
    idUnique
    blocked
    subscribeTime
    unsubscribeTime
    tags
    optionalFields {
      id
      values
    }
  }
}

Variables

{
  "idEmailSet": 123,
  "idEmail": 123,
  "input": UpdateEmailInput
}

Response

{
  "data": {
    "updateEmail": {
      "id": 123,
      "email": "xyz789",
      "idUnique": "xyz789",
      "blocked": "xyz789",
      "subscribeTime": "2007-12-03",
      "unsubscribeTime": "2007-12-03",
      "tags": ["abc123"],
      "optionalFields": [EmailField]
    }
  }
}

Mutations

`updateEmailSet`

Response

Returns an EmailSet!

Arguments

Name	Description
`id` - `Int!`
`input` - `UpdateEmailSetInput!`

Example

Query

mutation updateEmailSet(
  $id: Int!,
  $input: UpdateEmailSetInput!
) {
  updateEmailSet(
    id: $id,
    input: $input
  ) {
    id
    creationTime
    modifyTime
    name
    comment
    emailnumber
    type
    uploadStatus
    customFields {
      id
      name
      type
      hidden
      formName
      mergeTag
      required
      choices
    }
    tags
    segments {
      id
      tags
      rule
      name
    }
    formToken
  }
}

Variables

{"id": 123, "input": UpdateEmailSetInput}

Response

{
  "data": {
    "updateEmailSet": {
      "id": 987,
      "creationTime": "2007-12-03",
      "modifyTime": "2007-12-03",
      "name": "xyz789",
      "comment": "xyz789",
      "emailnumber": 987,
      "type": "T",
      "uploadStatus": 123,
      "customFields": [CustomField],
      "tags": ["abc123"],
      "segments": [Segment],
      "formToken": "abc123"
    }
  }
}

Mutations

`updateNewsletter`

Response

Returns a Newsletter

Arguments

Name	Description
`id` - `ID!`
`input` - `UpdateNewsletterInput!`

Example

Query

mutation updateNewsletter(
  $id: ID!,
  $input: UpdateNewsletterInput!
) {
  updateNewsletter(
    id: $id,
    input: $input
  ) {
    id
    title
    creationTime
    comment
    sender {
      personal
      email
    }
    subject
    preview
    status
    html
    template
    scheduledTime
    emailset {
      id
      creationTime
      modifyTime
      name
      comment
      emailnumber
      type
      uploadStatus
      customFields {
        ...CustomFieldFragment
      }
      tags
      segments {
        ...SegmentFragment
      }
      formToken
    }
    segment {
      id
      tags
      rule
      name
    }
    stats {
      recipients
      totalDelivered
      totalUnsubscribed
      totalBounced
      totalClicks
      uniqueClicks
      totalOpens
      uniqueOpens
      fromCatapulta
      catapultaStats
      links {
        ...NewsletterStatsLinkFragment
      }
      quickStats
    }
    canSend
    canSendTest
  }
}

Variables

{"id": 4, "input": UpdateNewsletterInput}

Response

{
  "data": {
    "updateNewsletter": {
      "id": "4",
      "title": "xyz789",
      "creationTime": "2007-12-03",
      "comment": "abc123",
      "sender": Sender,
      "subject": "abc123",
      "preview": "abc123",
      "status": "xyz789",
      "html": "xyz789",
      "template": {},
      "scheduledTime": "2007-12-03",
      "emailset": EmailSet,
      "segment": Segment,
      "stats": NewsletterStats,
      "canSend": false,
      "canSendTest": true
    }
  }
}

Mutations

`verifyPersonality`

Response

Returns a Personality!

Arguments

Name	Description
`id` - `Int!`
`code` - `String!`

Example

Query

mutation verifyPersonality(
  $id: Int!,
  $code: String!
) {
  verifyPersonality(
    id: $id,
    code: $code
  ) {
    id
    email
    name
    validated
  }
}

Variables

{"id": 987, "code": "abc123"}

Response

{
  "data": {
    "verifyPersonality": {
      "id": 123,
      "email": "abc123",
      "name": "xyz789",
      "validated": false
    }
  }
}

Types

Account

Fields

Field Name	Description
`uniqueId` - `String!`
`credits` - `Int!`
`creditsExpirationDate` - `Date`
`maxSendMonth` - `Int`
`maxSendDay` - `Int`
`countContacts` - `Int!`
`sentTotal` - `Int!`
`sentEmailInCurrentMonth` - `Int!`
`sentEmailInCurrentDay` - `Int!`
`planType` - `AccountPlainType!`
`plan` - `AccountPlan!`
`email` - `String!`
`personal` - `String`

Example

{
  "uniqueId": "abc123",
  "credits": 123,
  "creditsExpirationDate": "2007-12-03",
  "maxSendMonth": 123,
  "maxSendDay": 987,
  "countContacts": 123,
  "sentTotal": 987,
  "sentEmailInCurrentMonth": 123,
  "sentEmailInCurrentDay": 987,
  "planType": "consumable",
  "plan": "TRIAL",
  "email": "abc123",
  "personal": "xyz789"
}

Types

AccountPlainType

Values

Enum Value	Description
`consumable`
`subscription`

Example

"consumable"

Types

AccountPlan

Values

Enum Value	Description
`TRIAL`
`FREE`
`FULL`

Example

"TRIAL"

Types

AccountsPaginated

Fields

Field Name	Description
`nodes` - `[Account!]!`
`total` - `Int!`
`limit` - `Int!`
`offset` - `Int!`

Example

{
  "nodes": [Account],
  "total": 123,
  "limit": 987,
  "offset": 987
}

Types

AddCustomFieldInput

Fields

Input Field	Description
`name` - `String!`
`type` - `CustomFieldType!`
`hidden` - `Boolean!`
`mergeTag` - `String!`
`required` - `Boolean!`
`choices` - `[String]!`

Example

{
  "name": "xyz789",
  "type": "TEXTFIELD",
  "hidden": false,
  "mergeTag": "xyz789",
  "required": true,
  "choices": ["xyz789"]
}

Types

AuthUser

Fields

Field Name	Description
`token` - `String!`
`uniqueId` - `String!`
`email` - `String!`

Example

{
  "token": "abc123",
  "uniqueId": "xyz789",
  "email": "abc123"
}

Types

BannedEmail

Fields

Field Name	Description
`id` - `Int!`
`email` - `String!`
`type` - `BannedEmailType!`
`bannedTime` - `Date!`
`emailsetName` - `String`
`newsletterId` - `Int`
`newsletterTitle` - `String`

Example

{
  "id": 123,
  "email": "xyz789",
  "type": "A",
  "bannedTime": "2007-12-03",
  "emailsetName": "abc123",
  "newsletterId": 987,
  "newsletterTitle": "xyz789"
}

Types

BannedEmailType

Values

Enum Value	Description
`A`
`N`

Example

"A"

Types

BannedEmailsPaginated

Fields

Field Name	Description
`nodes` - `[BannedEmail!]!`
`total` - `Int!`
`limit` - `Int!`
`offset` - `Int!`

Example

{
  "nodes": [BannedEmail],
  "total": 987,
  "limit": 987,
  "offset": 987
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CSVUploadColumnDef

Fields

Input Field	Description
`type` - `CSVUploadColumnDefType!`
`name` - `String`
`id` - `String`

Example

{
  "type": "email",
  "name": "abc123",
  "id": "abc123"
}

Types

CSVUploadColumnDefType

Values

Enum Value	Description
`email`
`field`
`tag`
`new`
`ignore`

Example

"email"

Types

CreateEmailInput

Fields

Input Field	Description
`email` - `String!`
`optionalFields` - `[EmailFieldInput!]!`

Example

{
  "email": "abc123",
  "optionalFields": [EmailFieldInput]
}

Types

CreateEmailSetInput

Fields

Input Field	Description
`name` - `String!`
`comment` - `String`

Example

{
  "name": "abc123",
  "comment": "abc123"
}

Types

CreateNewsletterInput

Fields

Input Field	Description
`title` - `String`
`comment` - `String`
`html` - `String`
`subject` - `String`
`preview` - `String`
`template` - `JSONObject`
`sender` - `SenderInput`
`recipients` - `RecipientsInput`

Example

{
  "title": "xyz789",
  "comment": "xyz789",
  "html": "abc123",
  "subject": "xyz789",
  "preview": "abc123",
  "template": {},
  "sender": SenderInput,
  "recipients": RecipientsInput
}

Types

CreateOrUpdateEmailInput

Fields

Input Field	Description
`email` - `String!`
`optionalFields` - `[EmailFieldInput!]`

Example

{
  "email": "abc123",
  "optionalFields": [EmailFieldInput]
}

Types

CreatePersonalityInput

Fields

Input Field	Description
`email` - `String!`
`name` - `String!`
`activationEmailSubject` - `String!`
`activationEmailHtml` - `String!`

Example

{
  "email": "abc123",
  "name": "xyz789",
  "activationEmailSubject": "xyz789",
  "activationEmailHtml": "abc123"
}

Types

CreateSegmentInput

Fields

Input Field	Description
`tags` - `[String!]!`
`rule` - `EmailSegmentRule!`
`name` - `String!`

Example

{
  "tags": ["abc123"],
  "rule": "AND",
  "name": "xyz789"
}

Types

CustomField

Fields

Field Name	Description
`id` - `String!`
`name` - `String!`
`type` - `CustomFieldType!`
`hidden` - `Boolean!`
`formName` - `String`
`mergeTag` - `String!`
`required` - `Boolean!`
`choices` - `[String]!`

Example

{
  "id": "abc123",
  "name": "xyz789",
  "type": "TEXTFIELD",
  "hidden": false,
  "formName": "abc123",
  "mergeTag": "abc123",
  "required": true,
  "choices": ["xyz789"]
}

Types

CustomFieldType

Values

Enum Value	Description
`TEXTFIELD`

Example

"TEXTFIELD"

Types

Date

Example

"2007-12-03"

Types

DetailedStats

Fields

Field Name	Description
`result` - `String`

Example

{"result": "xyz789"}

Types

EditCustomFieldInput

Fields

Input Field	Description
`name` - `String`
`type` - `CustomFieldType`
`hidden` - `Boolean`
`mergeTag` - `String`
`required` - `Boolean`
`choices` - `[String]`

Example

{
  "name": "xyz789",
  "type": "TEXTFIELD",
  "hidden": true,
  "mergeTag": "xyz789",
  "required": false,
  "choices": ["xyz789"]
}

Types

EditPersonalityInput

Fields

Input Field	Description
`name` - `String!`

Example

{"name": "abc123"}

Types

EditSegmentInput

Fields

Input Field	Description
`tags` - `[String!]`
`rule` - `EmailSegmentRule`
`name` - `String`

Example

{
  "tags": ["xyz789"],
  "rule": "AND",
  "name": "xyz789"
}

Types

Email

Fields

Field Name	Description
`id` - `Int!`
`email` - `String!`
`idUnique` - `String!`
`blocked` - `String`
`subscribeTime` - `Date!`
`unsubscribeTime` - `Date`
`tags` - `[String!]!`
`optionalFields` - `[EmailField!]!`

Example

{
  "id": 123,
  "email": "xyz789",
  "idUnique": "xyz789",
  "blocked": "xyz789",
  "subscribeTime": "2007-12-03",
  "unsubscribeTime": "2007-12-03",
  "tags": ["abc123"],
  "optionalFields": [EmailField]
}

Types

EmailField

Fields

Field Name	Description
`id` - `String!`
`values` - `[String!]!`

Example

{
  "id": "abc123",
  "values": ["xyz789"]
}

Types

EmailFieldInput

Fields

Input Field	Description
`id` - `String!`
`values` - `[String!]!`

Example

{
  "id": "xyz789",
  "values": ["abc123"]
}

Types

EmailSegmentInput

Fields

Input Field	Description
`tags` - `[String!]!`
`rule` - `EmailSegmentRule!`

Example

{"tags": ["xyz789"], "rule": "AND"}

Types

EmailSegmentRule

Values

Enum Value	Description
`AND`
`OR`

Example

"AND"

Types

EmailSet

Fields

Field Name	Description
`id` - `Int!`
`creationTime` - `Date!`
`modifyTime` - `Date!`
`name` - `String!`
`comment` - `String`
`emailnumber` - `Int!`
`type` - `EmailSetType!`
`uploadStatus` - `Int`
`customFields` - `[CustomField!]!`
`tags` - `[String!]!`
`segments` - `[Segment!]!`
`formToken` - `String!`

Example

{
  "id": 987,
  "creationTime": "2007-12-03",
  "modifyTime": "2007-12-03",
  "name": "abc123",
  "comment": "xyz789",
  "emailnumber": 123,
  "type": "T",
  "uploadStatus": 987,
  "customFields": [CustomField],
  "tags": ["xyz789"],
  "segments": [Segment],
  "formToken": "xyz789"
}

Types

EmailSetType

Values

Enum Value	Description
`T`
`R`
`L`
`D`

Example

"T"

Types

EmailSetsPaginated

Fields

Field Name	Description
`nodes` - `[EmailSet!]!`
`total` - `Int!`
`limit` - `Int!`
`offset` - `Int!`

Example

{
  "nodes": [EmailSet],
  "total": 123,
  "limit": 987,
  "offset": 987
}

Types

EmailsPaginated

Fields

Field Name	Description
`nodes` - `[Email!]!`
`total` - `Int!`
`limit` - `Int!`
`offset` - `Int!`

Example

{
  "nodes": [Email],
  "total": 987,
  "limit": 123,
  "offset": 987
}

Types

GetAccountsInput

Fields

Input Field	Description
`limit` - `Int!`
`offset` - `Int!`
`search` - `String`
`order` - `GetAccountsOrderByInput`

Example

{
  "limit": 987,
  "offset": 987,
  "search": "abc123",
  "order": GetAccountsOrderByInput
}

Types

GetAccountsOrderByInput

Fields

Input Field	Description
`order` - `OrderingRule`
`field` - `GetAccountsOrderField`

Example

{"order": "desc", "field": "email"}

Types

GetAccountsOrderField

Values

Enum Value	Description
`email`
`personal`
`creation_time`

Example

"email"

Types

GetBannedEmailsInput

Fields

Input Field	Description
`limit` - `Int!`
`offset` - `Int!`
`search` - `String`

Example

{
  "limit": 987,
  "offset": 987,
  "search": "abc123"
}

Types

GetEmailSetsInput

Fields

Input Field	Description
`limit` - `Int!`
`offset` - `Int!`
`search` - `String`

Example

{
  "limit": 987,
  "offset": 123,
  "search": "xyz789"
}

Types

GetEmailsInput

Fields

Input Field	Description
`limit` - `Int!`
`offset` - `Int!`
`search` - `String`
`segment` - `EmailSegmentInput`
`order` - `GetEmailsOrderByInput`

Example

{
  "limit": 123,
  "offset": 123,
  "search": "xyz789",
  "segment": EmailSegmentInput,
  "order": GetEmailsOrderByInput
}

Types

GetEmailsOrderByInput

Fields

Input Field	Description
`order` - `OrderingRule`
`field` - `GetEmailsOrderField`

Example

{"order": "desc", "field": "email"}

Types

GetEmailsOrderField

Values

Enum Value	Description
`email`
`blocked`
`subscribe_time`

Example

"email"

Types

GetNewslettersInput

Fields

Input Field	Description
`limit` - `Int!`
`offset` - `Int!`
`status` - `String`
`search` - `String`

Example

{
  "limit": 123,
  "offset": 987,
  "status": "xyz789",
  "search": "xyz789"
}

Types

GetPersonalitiesInput

Fields

Input Field	Description
`onlyValidated` - `Boolean!`

Example

{"onlyValidated": true}

Types

GetTemplatesInput

Fields

Input Field	Description
`type` - `TemplateType!`

Example

{"type": "ALL"}

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"4"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

JSONObject

Example

{}

Types

LoadZipInput

Fields

Input Field	Description
`url` - `String!`
`unsubscribe` - `Boolean!`

Example

{"url": "xyz789", "unsubscribe": false}

Types

LoginInput

Fields

Input Field	Description
`email` - `String!`
`password` - `String!`

Example

{
  "email": "xyz789",
  "password": "abc123"
}

Types

Fields

Field Name	Description
`id` - `ID!`
`title` - `String`
`creationTime` - `Date`
`comment` - `String`
`sender` - `Sender`
`subject` - `String`
`preview` - `String`
`status` - `String`
`html` - `String`
`template` - `JSONObject`
`scheduledTime` - `Date`
`emailset` - `EmailSet`
`segment` - `Segment`
`stats` - `NewsletterStats`
`canSend` - `Boolean!`
`canSendTest` - `Boolean!`

Example

{
  "id": 4,
  "title": "abc123",
  "creationTime": "2007-12-03",
  "comment": "xyz789",
  "sender": Sender,
  "subject": "abc123",
  "preview": "abc123",
  "status": "abc123",
  "html": "xyz789",
  "template": {},
  "scheduledTime": "2007-12-03",
  "emailset": EmailSet,
  "segment": Segment,
  "stats": NewsletterStats,
  "canSend": true,
  "canSendTest": false
}

Types

NewsletterStats

Fields

Field Name	Description
`recipients` - `Int!`
`totalDelivered` - `Int!`
`totalUnsubscribed` - `Int!`
`totalBounced` - `Int!`
`totalClicks` - `Int!`
`uniqueClicks` - `Int!`
`totalOpens` - `Int!`
`uniqueOpens` - `Int!`
`fromCatapulta` - `Boolean!`
`catapultaStats` - `JSONObject`
`links` - `[NewsletterStatsLink]`
`quickStats` - `Boolean!`

Example

{
  "recipients": 987,
  "totalDelivered": 123,
  "totalUnsubscribed": 123,
  "totalBounced": 123,
  "totalClicks": 123,
  "uniqueClicks": 123,
  "totalOpens": 123,
  "uniqueOpens": 123,
  "fromCatapulta": true,
  "catapultaStats": {},
  "links": [NewsletterStatsLink],
  "quickStats": true
}

Types

NewsletterStatsLink

Fields

Field Name	Description
`totalClicks` - `Int!`
`uniqueClicks` - `Int!`
`url` - `String!`

Example

{
  "totalClicks": 123,
  "uniqueClicks": 123,
  "url": "xyz789"
}

Types

NewslettersPaginated

Fields

Field Name	Description
`nodes` - `[Newsletter!]!`
`total` - `Int!`
`limit` - `Int!`
`offset` - `Int!`

Example

{
  "nodes": [Newsletter],
  "total": 987,
  "limit": 123,
  "offset": 987
}

Types

OrderingRule

Values

Enum Value	Description
`desc`
`asc`

Example

"desc"

Types

ParseEmailSetCSVData

Fields

Field Name	Description
`rowCount` - `Int!`
`examples` - `[String!]!`
`separator` - `String!`

Example

{
  "rowCount": 987,
  "examples": ["abc123"],
  "separator": "abc123"
}

Types

Personality

Fields

Field Name	Description
`id` - `Int!`
`email` - `String!`
`name` - `String!`
`validated` - `Boolean!`

Example

{
  "id": 987,
  "email": "xyz789",
  "name": "abc123",
  "validated": true
}

Types

RecipientsInput

Fields

Input Field	Description
`emailSetID` - `Int!`
`segmentID` - `Int`

Example

{"emailSetID": 123, "segmentID": 123}

Types

ScheduleNewsletterInput

Fields

Input Field	Description
`scheduledTime` - `Date`
`language` - `String`

Example

{
  "scheduledTime": "2007-12-03",
  "language": "xyz789"
}

Types

Segment

Fields

Field Name	Description
`id` - `Int!`
`tags` - `[String!]!`
`rule` - `EmailSegmentRule!`
`name` - `String!`

Example

{
  "id": 123,
  "tags": ["xyz789"],
  "rule": "AND",
  "name": "abc123"
}

Types

Sender

Fields

Field Name	Description
`personal` - `String`
`email` - `String`

Example

{
  "personal": "xyz789",
  "email": "xyz789"
}

Types

SenderInput

Fields

Input Field	Description
`name` - `String!`
`email` - `String!`

Example

{
  "name": "abc123",
  "email": "abc123"
}

Types

StartCSVUploadInput

Fields

Input Field	Description
`url` - `String!`
`columns` - `[CSVUploadColumnDef!]!`
`headers` - `Boolean!`
`replaceAll` - `Boolean!`
`separator` - `String!`

Example

{
  "url": "xyz789",
  "columns": [CSVUploadColumnDef],
  "headers": true,
  "replaceAll": false,
  "separator": "abc123"
}

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"abc123"

Types

Template

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`html` - `String!`
`type` - `TemplateType!`

Example

{
  "id": "4",
  "name": "xyz789",
  "html": "xyz789",
  "type": "ALL"
}

Types

TemplateType

Values

Enum Value	Description
`ALL`
`SYSTEM`
`ACCOUNT`

Example

"ALL"

Types

TransactionalEmail

Fields

Field Name	Description
`email` - `String!`
`messageSentId` - `String`
`status` - `String!`

Example

{
  "email": "xyz789",
  "messageSentId": "abc123",
  "status": "abc123"
}

Types

TransactionalEmailInput

Fields

Input Field	Description
`sender` - `SenderInput!`
`email` - `String!`
`subject` - `String!`
`html` - `String`
`templateId` - `String`
`placeholders` - `[EmailFieldInput]!`

Example

{
  "sender": SenderInput,
  "email": "abc123",
  "subject": "abc123",
  "html": "xyz789",
  "templateId": "abc123",
  "placeholders": [EmailFieldInput]
}

Types

UpdateEmailInput

Fields

Input Field	Description
`tags` - `[String!]`
`optionalFields` - `[EmailFieldInput!]`

Example

{
  "tags": ["abc123"],
  "optionalFields": [EmailFieldInput]
}

Types

UpdateEmailSetInput

Fields

Input Field	Description
`name` - `String!`
`comment` - `String`

Example

{
  "name": "xyz789",
  "comment": "abc123"
}

Types

UpdateNewsletterInput

Fields

Input Field	Description
`title` - `String`
`comment` - `String`
`html` - `String`
`subject` - `String`
`preview` - `String`
`template` - `JSONObject`
`sender` - `SenderInput`
`recipients` - `RecipientsInput`

Example

{
  "title": "abc123",
  "comment": "abc123",
  "html": "xyz789",
  "subject": "abc123",
  "preview": "abc123",
  "template": {},
  "sender": SenderInput,
  "recipients": RecipientsInput
}

Documentation by Anvil SpectaQL