Follow flags

Follow flags to receive email updates about targeting changes to a flag in a project and environment.

Several of the endpoints in the follow flags API require a member ID. The member ID is returned as part of the Invite new members and List account members responses. It is the _id field of each element in the items array.

Get followers of all flags in a given project and environment

Get followers of all flags in a given environment and project

Request
path Parameters
projectKey
required
string <string>

The project key

environmentKey
required
string <string>

The environment key

Responses
200

Flags and flag followers response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

get/api/v2/projects/{projectKey}/environments/{environmentKey}/followers
Request samples
Response samples
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}

Get followers of a flag in a project and environment

Get a list of members following a flag in a project and environment

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key

environmentKey
required
string <string>

The environment key

Responses
200

Flag followers response

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

get/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers
Request samples
Response samples
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}

Add a member as a follower of a flag in a project and environment

Add a member as a follower to a flag in a project and environment

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key

environmentKey
required
string <string>

The environment key

memberId
required
string <string>

The memberId of the member to add as a follower of the flag. Reader roles can only add themselves.

Responses
204

Action succeeded

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

put/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}
Request samples
Response samples
application/json
{
  • "code": "invalid_request",
  • "message": "Invalid request body"
}

Remove a member as a follower of a flag in a project and environment

Remove a member as a follower to a flag in a project and environment

Request
path Parameters
projectKey
required
string <string>

The project key

featureFlagKey
required
string <string>

The feature flag key

environmentKey
required
string <string>

The environment key

memberId
required
string <string>

The memberId of the member to remove as a follower of the flag. Reader roles can only remove themselves.

Responses
204

Action succeeded

400

Invalid request

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

delete/api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/followers/{memberId}
Request samples
Response samples
application/json
{
  • "code": "invalid_request",
  • "message": "Invalid request body"
}