broadcastAudience

Query

query BroadcastAudience($broadcastAudienceId: ID!) {
  broadcastAudience(broadcastAudienceId: $broadcastAudienceId) {
    id
    name
    type
    filters {
      tenantIds
      tierIds
      tenantFields {
        externalFieldId
        stringValue
        booleanValue
        numberValue
        stringArrayValue
        userReferenceValues
      }
      slackChannels {
        slackTeamId
        slackChannelId
      }
      slackChannelNameContains
      audienceIds
    }
    isDeleted
    createdAt {
      unixTimestamp
      iso8601
    }
  }
}

Variables

{
  "broadcastAudienceId": "id"
}

Response

{
  "data": {
    "broadcastAudience": {
      "id": "id",
      "name": "string",
      "type": "SLACK",
      "filters": {
        "tenantIds": [
          "id"
        ],
        "tierIds": [
          "id"
        ],
        "tenantFields": [
          {
            "externalFieldId": "id",
            "stringValue": "string",
            "booleanValue": true,
            "numberValue": 1.5,
            "stringArrayValue": [
              "string"
            ],
            "userReferenceValues": [
              "id"
            ]
          }
        ],
        "slackChannels": [
          {
            "slackTeamId": "id",
            "slackChannelId": "id"
          }
        ],
        "slackChannelNameContains": [
          "string"
        ],
        "audienceIds": [
          "id"
        ]
      },
      "isDeleted": true,
      "createdAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      }
    }
  }
}

QUERY

broadcastAudience(broadcastAudienceId: ID!): BroadcastAudience

Arguments

broadcastAudienceId

ID!

required

Returns

BroadcastAudience

ID!

name

String!

Human-readable name used to identify the audience. Internal only — it is never shown to recipients.

type

BroadcastType!

The channel this audience is written for. Must match the type of any broadcast it is attached to.

filters

BroadcastAudienceFilter!

What the audience selects, resolved to concrete recipients at send time rather than when saved. No rows at all means every recipient the broadcast may reach.

isDeleted

Boolean!

Whether the audience has been soft-deleted. Soft-deleted audiences are excluded from lists but stay queryable by ID, so the record of what a past broadcast was sent to survives.

createdAt

createdBy

updatedAt

updatedBy

deletedAt

deletedBy

Query

query BroadcastAudience($broadcastAudienceId: ID!) {
  broadcastAudience(broadcastAudienceId: $broadcastAudienceId) {
    id
    name
    type
    filters {
      tenantIds
      tierIds
      tenantFields {
        externalFieldId
        stringValue
        booleanValue
        numberValue
        stringArrayValue
        userReferenceValues
      }
      slackChannels {
        slackTeamId
        slackChannelId
      }
      slackChannelNameContains
      audienceIds
    }
    isDeleted
    createdAt {
      unixTimestamp
      iso8601
    }
  }
}

Variables

{
  "broadcastAudienceId": "id"
}

Response

{
  "data": {
    "broadcastAudience": {
      "id": "id",
      "name": "string",
      "type": "SLACK",
      "filters": {
        "tenantIds": [
          "id"
        ],
        "tierIds": [
          "id"
        ],
        "tenantFields": [
          {
            "externalFieldId": "id",
            "stringValue": "string",
            "booleanValue": true,
            "numberValue": 1.5,
            "stringArrayValue": [
              "string"
            ],
            "userReferenceValues": [
              "id"
            ]
          }
        ],
        "slackChannels": [
          {
            "slackTeamId": "id",
            "slackChannelId": "id"
          }
        ],
        "slackChannelNameContains": [
          "string"
        ],
        "audienceIds": [
          "id"
        ]
      },
      "isDeleted": true,
      "createdAt": {
        "unixTimestamp": "string",
        "iso8601": "string"
      }
    }
  }
}

Queries

Mutations

Types

Arguments

Returns