Actor Properties

Registering an Actor Property Name

Changed on

Registers a new actor property name for this project. Once registered, the property can be set on any App User or Public Link within the project via PATCH.

Property names follow the same rules as Entity property names: they must be non-empty, may contain letters, digits, hyphens, and underscores, and the name displayName (case-insensitive) is reserved. Property names must be unique within a project and the uniqueness check is case-insensitive, so region and Region cannot coexist.

Requires actor_property.update permission.

post/v1/projects/{projectId}/actor-properties

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/actor-properties
  • Auth
    none declared

Path parameters

projectIdnumber required

The numeric ID of the Project

Request body

namestring required

The name of the property to register.

Example request

{
  "name": "region"
}

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes