Create Person

post https://{api_url}/api/v5/admin/{company_id}/people

Creates a new bookable person.
People are the bookable members of staff who provide the various services your organisation
offers. Some organisations will not require the use of people, while other organisations will
have complete availability schedules and specific services provided by each person.
The what & where configuration can be used to determine which people at your business are
capable of providing which services and resources.

time	status	user agent
Retrieving recent requests…

Loading…

Path Params

company_id

string

required

Company ID

Body Params

name

string

required

description

string

group_id

int32

phone_prefix

string

phone

string

ical_link

string

order

int32

disabled

boolean

never_booked

boolean

notify

boolean

Defaults to true

reference

string

all_staff

boolean

True when creating an Admin that will be able to see other staff schedules, false otherwise

company_ids

array of int32s

List of company ids to which the staff member will be assigned to

company_ids

resource_ids

array of int32s

List of resource ids to which the staff member will be able to work at

resource_ids

service_ids

array of int32s

List of service ids to which the staff member will be able to offer

service_ids

queuing_disabled

boolean

Defaults to true

schedule

object

Response

Language

Credentials

URL


xxxxxxxxxx
13
1
curl --request POST \
2
     --url https://example.jrni.com/api/v5/admin/company_id/people \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "notify": true,
8
  "queuing_disabled": true,
9
  "schedule": {
10
    "style": 0
11
  }
12
}
13
'

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

application/json

200Person