Simulate a workflow with an existing or sample lead

POST

/api/v1/workflows/{id}/simulate

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/workflows/example/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "fixture": { "name": "example", "email": "hello@example.com", "status": "example", "custom_fields": { "additionalProperty": "example" } } }'

Pass a lead_id or a sample lead (name, email, status, custom fields); nothing is sent or changed.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

lead_id

string

/^[0-9a-fA-F]{24}$/

fixture

object

name

required

string

>= 1 characters <= 200 characters

email

required

string format: email

status

string

<= 100 characters

custom_fields

object

key

additional properties

Example^generated

{
  "lead_id": "example",
  "fixture": {
    "name": "example",
    "email": "hello@example.com",
    "status": "example",
    "custom_fields": {
      "additionalProperty": "example"
    }
  }
}

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}