API Reference

PUT workflows/{id}/Z

PUT
workflows/{id}/Z

PUT operation for workflows/{id}/Z

Authorization

ApiKeyAuth
Authorization<token>

API key authentication. Format: Your API key (no "Token" prefix needed)

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PUT "https://dev-rest.onboard.io/workflows/{id}/Z" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "workflow_type": "string"  }'
{
  "id": 0,
  "name": "string",
  "workflow_type": "string",
  "workflow_actions": "string",
  "workflow_actions_display": "string",
  "trigger": "string",
  "trigger_display": "string",
  "internal_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "modified_at": "2019-08-24T14:15:22Z",
  "created_by": "string",
  "button_color": "string",
  "button_placement": "string",
  "button_title": "string",
  "is_enabled": true,
  "filters": {},
  "filters_rql": "string",
  "workflow_events": "string",
  "is_hidden": true,
  "schedule_type": "string",
  "schedule_day": 0,
  "schedule_time": "14:15:22Z"
}
Empty
Empty
Empty

How is this guide?

DELETE workflows/{id}/Z DELETE

DELETE operation for workflows/{id}/Z

POST workflows/{id}/run/Z POST

POST operation for workflows/{id}/run/Z