PAGERDUTY_MODIFY_ENTITY_TAGS

This endpoint allows you to modify the tags associated with a specific entity in PagerDuty. It provides functionality to both add new tags and remove existing ones in a single API call. The endpoint is particularly useful for updating the categorization or labeling of PagerDuty entities such as incidents, services, or users. It supports adding tags by label (creating new ones if necessary) or by reference, and removing tags by their unique identifiers. This flexibility allows for efficient tag management across your PagerDuty resources, enabling better organization and easier searching of entities. Use this endpoint when you need to update the tags for a specific entity, either to refine its categorization or to align it with current operational needs.

Available from 1 provider (1 remote)

Input Schema

            {
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "Id",
      "description": "The ID of the resource."
    },
    "add": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "AddRequest",
        "required": [
          "type"
        ],
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The id of the tag. Should be used when type is \"tag_reference\"."
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "Type"
          },
          "label": {
            "type": "string",
            "title": "Label",
            "description": "The label of the tag. Should be used when type is \"tag\"."
          }
        },
        "description": "Request schema for `Add`"
      },
      "title": "Add",
      "description": "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": {
      "type": "array",
      "items": {
        "type": "object",
        "title": "RemoveRequest",
        "required": [
          "type",
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "title": "Id",
            "description": "The id of the tag"
          },
          "type": {
            "type": "string",
            "title": "Type",
            "description": "Type"
          }
        },
        "description": "Request schema for `Remove`"
      },
      "title": "Remove",
      "description": "Array of tag references to remove from the entity."
    },
    "entity_type": {
      "enum": [
        "users",
        "teams",
        "escalation_policies"
      ],
      "type": "string",
      "title": "Entity Type",
      "description": "Type of entity related with the tag"
    }
  }
}