diff --git a/docs/content/docs/Technical/api.md b/docs/content/docs/Technical/api.md index a10f95ebe..60d4e9388 100644 --- a/docs/content/docs/Technical/api.md +++ b/docs/content/docs/Technical/api.md @@ -168,11 +168,11 @@ requests.post( ``` ### Update an incident's attribute value -`POST /api/v2/update/:slug/:attribute_name` updates the attribute `:attribute_name` in the incident with slug `:slug`. It has two parameters: +`POST /api/v2/update/:slug/:attribute_identifier` updates the attribute `:attribute_identifier` in the incident with slug `:slug`. It has two parameters: - `value`, the new value of the attribute (required). For text or single-select attributes, `value` should be a string. For multi-select attributes, `value` should be a list of strings. - `message`, a string to be displayed as an explanation for the update (optional). If `message` is provided, it will be added as a comment to the incident (as part of the tracked change). -The `:attribute_name` may not be the name of the attribute displayed in the interface: +You can find the `:attribute_identifier` in the **Access** pane of your project. Attribute's names in the Atlos interface are different from their API identifiers: - Core attributes have string names (such as `description` and `status`). - Custom attributes are identified by a long ID.