API Reference
  1. One Church Software API
  2. Workflows

Create workflow

post
https://{tenant}.onechurchsoftware.com/api/workflows

Create a new workflow. The calling user is automatically added as a manager. Tasks are designed in the workflow editor and cannot be created through the API. Returns the id and name of the new workflow.

Required permission: Full Write Workflows

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the workflow

string | null
required

The name of the workflow.

buffer
object | null
required

The re-entry buffer: how long after leaving the workflow a person must wait before they can re-enter it.

string | null

The description of the workflow.

boolean

Whether the workflow is enabled.

category
object | null

The workflow's category. Null when the workflow has no category. On writes, provide the id or code; values come from /api/property_values/workflow_categories/values.

layout
object | null

The editor layout of the workflow: vertical or horizontal. On writes, provide the code; defaults to vertical when omitted.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated about 2 months ago

Did this page help you?