--- title: "Update global incident handle" method: PUT path: "/api/v2/incidents/config/global/incident-handles" tags: ["Incidents"] --- # Update global incident handle `PUT /api/v2/incidents/config/global/incident-handles` ## Request - Base URL: `https://api.datadoghq.com` - URL: `https://api.datadoghq.com/api/v2/incidents/config/global/incident-handles` - Auth: API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY` Update an existing global incident handle. ## Query parameters - `include` string ## Request body - IncidentHandleRequest: Request payload for creating or updating a global incident handle. - `data` IncidentHandleDataRequest, required: Data object representing an incident handle in a create or update request. - `attributes` IncidentHandleAttributesRequest, required: Incident handle attributes for requests - `fields` IncidentHandleAttributesFields: Dynamic fields associated with the handle - `severity` IncidentHandleAttributesFieldsSeverity[]: Severity levels associated with the handle - `name` string, required: The handle name - `id` string: The ID of the incident handle (required for PUT requests) - `relationships` IncidentHandleRelationshipsRequest, nullable: Relationships to associate with an incident handle in a create or update request. - `commander_user` IncidentHandleRelationship: A single relationship object for an incident handle, wrapping the related resource data. - `data` IncidentHandleRelationshipData, required: Relationship data for an incident handle, containing the ID and type of the related resource. - `id` string, required: The ID of the related resource - `type` string, required: The type of the related resource - `incident_type` IncidentHandleRelationship, required: A single relationship object for an incident handle, wrapping the related resource data. - `data` IncidentHandleRelationshipData, required: Relationship data for an incident handle, containing the ID and type of the related resource. - `id` string, required: The ID of the related resource - `type` string, required: The type of the related resource - `type` 'incidents_handles', required: Incident handle resource type ## Response `200` OK - IncidentHandleResponse: Response payload for a single incident handle, including the handle data and related resources. - `data` IncidentHandleDataResponse, required: Data object representing an incident handle in a response. - `attributes` IncidentHandleAttributesResponse, required: Incident handle attributes for responses - `created_at` string, date-time, required: Timestamp when the handle was created - `fields` IncidentHandleAttributesFields, required: Dynamic fields associated with the handle - `severity` IncidentHandleAttributesFieldsSeverity[]: Severity levels associated with the handle - `modified_at` string, date-time, required: Timestamp when the handle was last modified - `name` string, required: The handle name - `id` string, required: The ID of the incident handle - `relationships` IncidentHandleRelationships, nullable: Relationships associated with an incident handle response, including linked users and incident type. - `commander_user` IncidentHandleRelationship: A single relationship object for an incident handle, wrapping the related resource data. - `data` IncidentHandleRelationshipData, required: Relationship data for an incident handle, containing the ID and type of the related resource. - `id` string, required: The ID of the related resource - `type` string, required: The type of the related resource - `created_by_user` IncidentHandleRelationship, required: A single relationship object for an incident handle, wrapping the related resource data. - `data` IncidentHandleRelationshipData, required: Relationship data for an incident handle, containing the ID and type of the related resource. - `id` string, required: The ID of the related resource - `type` string, required: The type of the related resource - `incident_type` IncidentHandleRelationship, required: A single relationship object for an incident handle, wrapping the related resource data. - `data` IncidentHandleRelationshipData, required: Relationship data for an incident handle, containing the ID and type of the related resource. - `id` string, required: The ID of the related resource - `type` string, required: The type of the related resource - `last_modified_by_user` IncidentHandleRelationship, required: A single relationship object for an incident handle, wrapping the related resource data. - `data` IncidentHandleRelationshipData, required: Relationship data for an incident handle, containing the ID and type of the related resource. - `id` string, required: The ID of the related resource - `type` string, required: The type of the related resource - `type` 'incidents_handles', required: Incident handle resource type - `included` IncidentHandleIncludedItemResponse[]: Included related resources - union: A single included resource item in an incident handle response, which can be a user or an incident type. - IncidentUserData: User object returned by the API. - `attributes` IncidentUserAttributes: Attributes of user object returned by the API. - `email` string: Email of the user. - `handle` string: Handle of the user. - `icon` string: URL of the user's icon. - `name` string, nullable: Name of the user. - `uuid` string: UUID of the user. - `id` string: ID of the user. - `type` 'users': Users resource type. - IncidentTypeObject: Incident type response data. - `attributes` IncidentTypeAttributes: Incident type's attributes. - `configuration` IncidentTypeConfiguration: The incident-type-scoped behavior settings. All fields are optional on update. Any field omitted from a PATCH request keeps its current value. This object is read-only on the incident type resource itself and is only mutated through the update (PATCH) endpoint. - `allow_incident_deletion` boolean: Whether incidents of this type can be deleted. - `allow_workflows` boolean: Whether automation workflows can be triggered for incidents of this type. - `create_message` string: An optional message shown to users when they declare an incident of this type. - `editable_timestamps` boolean: Whether responders can edit incident timestamps for incidents of this type. - `private_incidents` boolean: Whether responders can create private incidents of this type. This is an opt-in setting, distinct from `private_incidents_by_default`, which controls whether incidents are created private automatically. - `private_incidents_by_default` boolean: Whether incidents of this type are created as private by default. - `slug_source` 'default' | 'servicenow': When set to `servicenow`, incidents will display the ServiceNow record ID instead of the public ID. If no ServiceNow integration exists, the public ID will be displayed. - `test_incidents` boolean: Whether incidents of this type are treated as test incidents. - `createdAt` string, date-time: Timestamp when the incident type was created. - `createdBy` string: A unique identifier that represents the user that created the incident type. - `description` string: Text that describes the incident type. - `is_default` boolean: If true, this incident type will be used as the default incident type if a type is not specified during the creation of incident resources. - `lastModifiedBy` string: A unique identifier that represents the user that last modified the incident type. - `modifiedAt` string, date-time: Timestamp when the incident type was last modified. - `name` string, required: The name of the incident type. - `prefix` string: The string that will be prepended to the incident title across the Datadog app. - `id` string, required: The incident type's ID. - `relationships` IncidentTypeRelationships: The incident type's resource relationships. - `created_by_user` RelationshipToUser: Relationship to user. - `data` RelationshipToUserData, required: Relationship to user object. - … - `google_meet_configuration` GoogleMeetConfigurationReference, nullable: A reference to a Google Meet Configuration resource. - `data` GoogleMeetConfigurationReferenceData, nullable, required: The Google Meet configuration relationship data object. - … - `last_modified_by_user` RelationshipToUser: Relationship to user. - `data` RelationshipToUserData, required: Relationship to user object. - … - `microsoft_teams_configuration` MicrosoftTeamsConfigurationReference, nullable: A reference to a Microsoft Teams Configuration resource. - `data` MicrosoftTeamsConfigurationReferenceData, nullable, required: The Microsoft Teams configuration relationship data object. - … - `zoom_configuration` ZoomConfigurationReference, nullable: A reference to a Zoom configuration resource. - `data` ZoomConfigurationReferenceData, nullable, required: The Zoom configuration relationship data object. - … - `type` 'incident_types', required: Incident type resource type. ## Other responses - `400`: Bad Request - `429`: Too many requests --- [API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/da68bf029e4c?raw)