Assign tags

Assign existing or new tags.

A Tag is applied to Escalation Policies, Teams or Users and can be used to filter them.

For more information see the API Concepts Document

Scoped OAuth requires: tags.write

Authorization

api_key

Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

entity_type*string

Type of entity related with the tag

Value in

"users"
"teams"
"escalation_policies"

id*string

The ID of the resource.

Header Parameters

Accept*string

The Accept header is used as a versioning header.

Default"application/vnd.pagerduty+json;version=2"

Content-Type*"application/json"

Default"application/json"

Value in

"application/json"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Tags to add to or remove from the entity.

add?array<>

Array of tags and/or tag references to add to the entity. For elements with type tag_reference, the tag with the corresponding id is added to the entity. For elements with type tag, if there is an existing tag with the given label that tag is added to the entity. If there is no existing tag with that label and the user has permission to create tags, a new tag is created with that label and assigned to the entity.

remove?array<>

Array of tag references to remove from the entity.

Response Body

`application/json`

curl -X POST "https://api.pagerduty.com/users/{id}/change_tags" \  -H "Accept: application/vnd.pagerduty+json;version=2" \  -H "Content-Type: application/json" \  -H "Content-Type: application/json" \  -d '{    "add": [      {        "type": "tag",        "label": "Batman"      },      {        "type": "tag_reference",        "id": "P5IYCNZ"      }    ],    "remove": [      {        "type": "tag_reference",        "id": "POE7RY8"      },      {        "type": "tag_reference",        "id": "PG68P1M"      }    ]  }'

{  "add": [    {      "type": "tag",      "label": "Batman"    },    {      "type": "tag_reference",      "id": "P5IYCNZ"    }  ],  "remove": [    {      "type": "tag_reference",      "id": "POE7RY8"    },    {      "type": "tag_reference",      "id": "PG68P1M"    }  ]}

Assign tags

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

Developer Agreement

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`