Sign in

v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB
Audiences

Update an Audience

Update an Audience by ID or key

patch/v1/projects/{project}/audiences/{key}

Path parameters

keystring required

A Audience key or ID

projectstring required

A Project key or ID

Request body

namestring

Audience display name, must be set for project-level audiences.

keystring

Audience unique project-level key, must be set for project-level audiences. Must only contain lower-case characters and _, - or ..

descriptionstring

Audience description.

tagsstring[]

Tags to organize project-level audiences on the dashboard

Example request

{
  "name": "Android Users",
  "key": "android-users",
  "description": "Users with android devices",
  "filters": {
    "filters": [
      {
        "subType": "email",
        "comparator": "!=",
        "values": [
          "baduser@email.com"
        ],
        "type": "user"
      }
    ]
  }
}

Response

namestring

Audience display name, must be set for project-level audiences.

keystring

Audience unique project-level key, must be set for project-level audiences. Must only contain lower-case characters and _, - or ..

descriptionstring

Audience description.

_idstring required

A unique Audience ID

_projectstring required

The Project owning the Audience

source'api' | 'dashboard' | 'importer' | 'github.code_usages' | 'github.pr_insights' | 'gitlab.code_usages' | 'gitlab.pr_insights' | 'bitbucket.code_usages' | 'bitbucket.pr_insights' | 'terraform' | 'cli' | 'slack' | 'mcp'

Source that created the Audience

_createdBystring

User who created the Audience

createdAtstring date-time required

The date the feature was created

updatedAtstring date-time required

The date the feature was last updated

tagsstring[]

Tags to organize project-level audiences on the dashboard

readonlyboolean required

Readonly state based on the Users Permission to modify the Audience

hasUsageboolean

Whether the audience is in use by a feature

Example response

{
  "name": "Android Users",
  "key": "android-users",
  "description": "Users with android devices",
  "_id": "61450f3daec96f5cf4a49946",
  "_project": "61450f3daec96f5cf4a49955",
  "filters": {
    "filters": [
      {
        "subType": "email",
        "comparator": "!=",
        "values": [
          "baduser@email.com"
        ],
        "type": "user"
      }
    ]
  },
  "readonly": true,
  "hasUsage": true
}