Create service type

post

https://{tenant}.onechurchsoftware.com/api/plans/servicetypes

Create a service type. Unless inline is true, the first plan of the new type is also scheduled at the given service times, and the response identifies that plan (its id, with its dates as the name); otherwise the response is the new service type's id and name.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The service type

name

string | null

required

The name of the service type.

frequency

object | null

required

How often plans of this type recur. Only the id is used when writing: 0 = randomly, 1 = daily, 2 = weekly, 3 = weekdays, 4 = weekends, 5 = biweekly, 6 = monthly.

description

string | null

The description of the service type.

default

boolean

Whether this is the default service type for new plans.

groups

array of objects | null

The teams that serve this service type. When writing, reference existing teams by id; an entry with a negative id creates a new team with the given name.

groups

files

array of objects | null

The attachments on this service type, inherited by its plans.

files

times

array of objects | null

The service times of the first plan, used when creating a service type without inline set.

times

noteCategories

array of objects | null

The note categories available on plans of this type.

noteCategories

inline

boolean | null

Set to true when creating to create only the service type. Otherwise the first plan of the type is also scheduled at the given times, and the response identifies that plan instead of the service type.

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.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK