[deprecated] Update an entity's situation and metadata

This endpoint is marked for deprecation. This method is still available to be used, but we do not guarantee it will be available to be used in future API versions. If you are using this endpoint, you should consider replacing it with /journeys/{journeyId}.

Operational Application Space Deprecated

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string

Unique identifier (per Lifecycle) for an entity being tracked.

date-time
date-time
string
required

Lifecycle identifier

string

Name of Lifecycle

integer
required

Version of Lifecycle (LifecycleVersion)

date-time
date-time
string
string
string
enum
Allowed:
string

Unique (per Lifecycle) name for a step.

string

Logical / display name (copied from LifecycleStep)

string
enum

Not_Started, In_Progress, or Done type of Step within the Lifecycle (copied from LifecycleVersionStep)

Allowed:
integer

Current cycle that the entity is on. The number is incremented each time the entity transitions from a 'Done' stepType to a non-'Done' stepType. This is interpreted as a restart or at least a new cycle. See also cycleStartCycleDatetime.

date-time

Start datetime of the step. Calculate difference from now to determine the age/duration.

string

JSON string containing current entityLifecycle path.

string

Customer identifier

string
integer

Current time, in seconds, of entity in current step.

integer

Current time, in seconds, of entity in current cycle.

integer

Current time, in seconds, of entity life.

entityLifecycleTags
array of objects

Array of entityLifecycleTags

entityLifecycleTags
metadata
array of objects

Most recent set of metadata for an entity

metadata
Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json