Update service type

put

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

Full update: the service type's teams, attachments, and note categories are replaced by the lists provided, so omitting one removes every entry in it. First retrieve the current service type from /api/plans/servicetypes/{id}, apply your changes, then send back the full object. Returns the service type's id and name.

Required permission: Full Write Service Plans

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the service type

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

404Not Found