Update an element

PUT/ui_identifiers/{element_id}

Base URL https://app.testsigma.com/api/v1Region

Update an existing element's locator, locator type, screen name, or other metadata by its ID.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →

Path parameters

element_id The ID of the element to update.

Request body

`name`	Updated element name.
`locatorType`	Updated locator strategy.
`definition`	Updated locator expression.
`status`	Updated review status — READY or DRAFT.
`screenNameId`	Updated screen ID.
`applicationVersionId`	Application version ID.

Response attributes

`id`	ID of the updated element.
`name`	Updated element name.
`locatorType`	Updated locator strategy.
`definition`	Updated locator expression.
`status`	Current review status.

Request

curl -X PUT \
  'https://app.testsigma.com/api/v1/ui_identifiers/{element_id}' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Submit Button",
    "locatorType": "css_selector",
    "definition": "button[type='submit']",
    "status": "READY",
    "screenNameId": 12,
    "applicationVersionId": 39,
    "createdType": "MANUAL"
  }'

const response = await fetch('https://app.testsigma.com/api/v1/ui_identifiers/{element_id}', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
      "name": "Submit Button",
      "locatorType": "css_selector",
      "definition": "button[type='submit']",
      "status": "READY",
      "screenNameId": 12,
      "applicationVersionId": 39,
      "createdType": "MANUAL"
  })
});
const data = await response.json();

import requests

response = requests.put(
  'https://app.testsigma.com/api/v1/ui_identifiers/{element_id}',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  },
  json={
      "name": "Submit Button",
      "locatorType": "css_selector",
      "definition": "button[type='submit']",
      "status": "READY",
      "screenNameId": 12,
      "applicationVersionId": 39,
      "createdType": "MANUAL"
  }
)
data = response.json()

Response200 OK

{
  "id": 103,
  "name": "Submit Button",
  "locatorType": "css_selector",
  "definition": "button[type='submit']",
  "status": "READY",
  "screenNameId": 12,
  "applicationVersionId": 39,
  "createdType": "MANUAL",
  "createdById": 9
}

Was this page helpful?