Element names

Name an element

Sets or replaces the name of one element, keyed by its selector. Plain words only: control characters are removed, whitespace collapses, and markup is refused with 400. A site can have 200 names. Needs an owner or editor; viewers and personal access tokens receive 403.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

put/v1/projects/{projectId}/element-names

Request

  • Base URL: https://hootlens-api-368877148687.us-east1.run.app
  • URL: https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/element-names
  • Auth: HTTP bearer

Path parameters

projectIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

The project ID. Project IDs are public identifiers, not secrets.

Request body

keystring required

The element's selector exactly as findings and heatmaps list it. A data-hoot-id selector is the stable one.

namestring required

What the team calls the element. Plain words, no markup.

Response

The name.

Changes

No recorded changes to this operation across all 1 revision of this API.