Skip to main content
POST
Set Display Name

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Given an entity profile, will update its display name to the one passed in if the profile's version is equal to the specified value

Given an entity profile, will update its display name to the one passed in if the profile's version is equal to the specified value

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

DisplayName
string

The new value to be set on Entity Profile's display name

Entity
object

The optional entity to perform this action on. Defaults to the currently logged in entity.

ExpectedVersion
number

The expected version of a profile to perform this update on

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026