Deal Step Meta

The Deal Step Meta API allows you to manage steps that are attached to deals.

These endpoints only allow you to view and manipulate top level deal step meta information.

The Deal Step Resource

Properties

Name
id
Required
Type
integer
Description
Unique identifier for the deal step mapping.
Name
deal_id
Required
Type
integer
Description
The ID of the deal for this deal step.
Name
step_id
Required
Type
integer
Description
The ID of the step for this deal step.
Name
completed_by
Required
Type
string
Description
ID of the user who marked this step as completed.
Name
verified_by
Required
Type
string
Description
ID of the user who marked this step as verified.
Name
flags
Required
Type
Description
Name
enabled
Required
Type
boolean
Description
Indicates whether the step is enabled, and edits can be made through the V3 UI.
Name
can_toggle
Required
Type
boolean
Description
Indicates the step can be enabled or disabled.
Name
metadata
Required
Type
object
Description
A key-value object containing metadata specific to the step.
Name
dates
Required
Type
object
Description
Name
completed_at
Required
Type
datetime | null
Description
The date the deal step was marked as complete, represented in YYYY-MM-DD HH:MM:SS format. Will be null if the deal step is not yet completed.
Name
verified_at
Required
Type
datetime | null
Description
The date the deal step was marked as verified, represented in YYYY-MM-DD HH:MM:SS format. Will be null if the deal step is not yet verified.
Name
created_at
Required
Type
datetime
Description
The date the deal step was created, represented in YYYY-MM-DD HH:MM:SS format
Name
updated_at
Required
Type
datetime
Description
The date the deal step was last updated, represented in YYYY-MM-DD HH:MM:SS format
Name
deleted_at
Required
Type
null | datetime
Description
The date the deal step was deleted, represented in YYYY-MM-DD HH:MM:SS format. If the deal step is not deleted, this will be null

Deal Step Resource

{
  "id": 1,
  "deal_id": 12345,
  "step_id": 10,
  "completed_by": 79,
  "verified_by": 728686,
  "flags": {
    "enabled": true,
    "can_toggle": false,
  },
  "metadata": {
    "substep": "example",
  },
  "dates": {
    "completed_at": "2024-01-03 00:00:00",
    "verified_at": "2024-01-03 00:01:00",
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-02 12:00:00",
    "deleted_at": null,
  }
}

POST/v2/apex/deals/:deal_id/steps/:step_id/reopen

Reopen Deal Step

Will attempt to reopen a completed or verified deal step.

Deal Steps cant always be reopened. For example, if the deal step is not enabled, or its a deal step for a previous phase. If the deal step cant be reopened, a 409 conflict error will be returned with details about why.

URL Parameters

Name
deal_id
Required
required
Type
integer
Description
ID of the deal which owns the step
Name
step_id
Required
required
Type
integer
Description
ID of the step to reopen

Error Codes

Status	Description
404	The requested deal could not be found.
404	The requested step could not be found.
409	The deal step is in an invalid state to be reopened.

Request

POST

/v2/apex/deals/:deal_id/steps/:step_id/reopen

use Compliance\Sdk\ApexV3\Contracts\ApexV3SdkInterface;
use Compliance\Sdk\Authentication\Types\Machine;

private ApexV3SdkInterface $sdk;

$response = $this->sdk
  ->v2(new Machine())
  ->apex()
  ->deal(1)
  ->step(2)
  ->reopen();

Response

{
  "data": {
    "id": 1,
    "deal_id": 12345,
    "step_id": 10,
    "completed_by": null,
    "verified_by": null,
    "flags": {
      "enabled": true,
      "can_toggle": false,
    },
    "metadata": {
      "substep": "example",
    },
    "dates": {
      "completed_at": null,
      "verified_at": null,
      "created_at": "2024-01-01 00:00:00",
      "updated_at": "2024-01-02 12:00:00",
      "deleted_at": null,
    }
  }
}