The action object

Attributes

• id integer

The action identifier.

• stepNumber integer

An integer representing the step number of an action.

• role integer

The role identifier.

• type string

The type of step can be sign or review.

• status string

The action status can be not_started, started, approved or declined.

• recipientId integer

The recipient identifier of the action.

• recipientEmail string

The recipient email of the action.

• comment string

An optional comment attached to the action.

Example

{
    "id": 1,
    "stepNumber": 1,
    "role": 1,
    "type": "sign",
    "status": "started",
    "recipientId": 1,
    "recipientEmail": "jane.doe@example.com",
    "comment": null
}