SalesOS.

Playbooks

Sales playbook management

Playbooks Controller_get Success Playbooks

GET
/v1/playbooks/success

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

categoryRequiredstring
curl -X GET "https://api.salesos.org/v1/playbooks/success?category=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_get Success Stats

GET
/v1/playbooks/success/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/playbooks/success/stats" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_get Success Executions

GET
/v1/playbooks/success/executions

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

playbookIdRequiredstring
curl -X GET "https://api.salesos.org/v1/playbooks/success/executions?playbookId=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_find All

GET
/v1/playbooks

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

isActiveRequiredstring
triggerRequiredstring
curl -X GET "https://api.salesos.org/v1/playbooks?isActive=%3Cstring%3E&trigger=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_create

POST
/v1/playbooks

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/playbooks" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_get Stats

GET
/v1/playbooks/stats

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/playbooks/stats" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_find One

GET
/v1/playbooks/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X GET "https://api.salesos.org/v1/playbooks/<string>" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_update

PATCH
/v1/playbooks/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X PATCH "https://api.salesos.org/v1/playbooks/<string>" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_delete

DELETE
/v1/playbooks/{id}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X DELETE "https://api.salesos.org/v1/playbooks/<string>" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_duplicate

POST
/v1/playbooks/{id}/duplicate

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/<string>/duplicate" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_add Step

POST
/v1/playbooks/{id}/steps

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/<string>/steps" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_update Step

PATCH
/v1/playbooks/{id}/steps/{stepId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
stepIdRequiredstring
curl -X PATCH "https://api.salesos.org/v1/playbooks/<string>/steps/<string>" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_delete Step

DELETE
/v1/playbooks/{id}/steps/{stepId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
stepIdRequiredstring
curl -X DELETE "https://api.salesos.org/v1/playbooks/<string>/steps/<string>" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_reorder Steps

POST
/v1/playbooks/{id}/steps/reorder

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/<string>/steps/reorder" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_get Executions

GET
/v1/playbooks/executions/list

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

playbookIdRequiredstring
dealIdRequiredstring
statusRequiredstring
curl -X GET "https://api.salesos.org/v1/playbooks/executions/list?playbookId=%3Cstring%3E&dealId=%3Cstring%3E&status=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_get Execution

GET
/v1/playbooks/executions/{executionId}

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

executionIdRequiredstring
curl -X GET "https://api.salesos.org/v1/playbooks/executions/<string>" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_start Execution

POST
/v1/playbooks/{id}/start

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/<string>/start" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_complete Step

POST
/v1/playbooks/executions/{executionId}/steps/{stepId}/complete

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

executionIdRequiredstring
stepIdRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/executions/<string>/steps/<string>/complete" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_skip Step

POST
/v1/playbooks/executions/{executionId}/steps/{stepId}/skip

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

executionIdRequiredstring
stepIdRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/executions/<string>/steps/<string>/skip" \
  -H "Authorization: Bearer <token>"

Playbooks Controller_cancel Execution

POST
/v1/playbooks/executions/{executionId}/cancel

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

executionIdRequiredstring
curl -X POST "https://api.salesos.org/v1/playbooks/executions/<string>/cancel" \
  -H "Authorization: Bearer <token>"

Digital Workers

Automated task execution bots

Workflows

Automation workflow management