Legacy Mailbox API 1.0 is deprecated

Legacy Mailbox API 1.0 was deprecated on November 20, 2019. Please use Mailbox API 2.0 going forward. If you have any questions or need help with the new API, please reach out.

Mailbox Workflow Object

Field Guide

Name Type Example Notes
id Int 1234 Unique identifier
mailboxId Int 100 The id of the mailbox that the workflow is associated with
type String manual The type of workflow:
  • automatic
  • manual
status String active The status of the workflow:
  • active
  • inactive
  • invalid
order Int 1 The order of the workflow.
name String My Workflow Workflow name
createdAt Datetime 2012-07-24T20:18:33Z UTC time when this workflow was created.
modifiedAt Datetime 2012-07-24T20:18:33Z UTC time when this workflow was modified.

Example

{	
    "id": 1234,
    "mailboxId": 100,
    "type": "manual",
    "status": "active",
    "order": 1,
    "name": "Mine",
    "createdAt": "2012-07-24T20:13:12Z"
    "modifiedAt": "2012-07-24T20:18:33Z"
}
↑Back to top
© Help Scout 2024