Create Event Type Host - Jicoo Developer Potal

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

Path Params

eventTypeId

string

required

Body Params application/json

uid

string

required

Unique ID of the host

userType

enum<string>

required

User type of the host

Allowed values:

hostnotifyHost

role

enum<string>

required

Role of the host

Allowed values:

admineditorviewer

priority

integer

optional

Round Robin Priority of the host

>= 0<= 3

Default:

0

sort

integer

optional

Sort value of the host

>= 0

Default:

0

Example

{
    "uid": "string",
    "userType": "host",
    "role": "admin",
    "priority": 0,
    "sort": 0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/event_types//hosts' \
--header 'Content-Type: application/json' \
--header 'X-Jicoo-Api-Key;' \
--data-raw '{
    "uid": "string",
    "userType": "host",
    "role": "admin",
    "priority": 0,
    "sort": 0
}'

Responses

🟢201Created

application/json

Body

object | null

optional

data

object (Host)

required

uid

string

required

Unique ID of the host

name

string

required

Name of the host

email

string <email>

required

Email of the host

profileImage

string | null

required

Profile image URL of the host

role

enum<string>

required

Role of the host

Allowed values:

admineditorviewer

priority

integer

required

Round Robin Priority of the host

>= 0<= 3

userType

enum<string>

required

User type of the host

Allowed values:

hostnotifyHost

sort

integer

required

Sort value of the host

>= 0

errors

object

required

Example

{
    "data": {
        "uid": "xxxxxxxxxxxxxxxxxxx",
        "name": "Angelo Effertz Jr.",
        "email": "Karl_OConner@example.com",
        "profileImage": "https://example.com/400/400?lock=5683920355372948",
        "role": "viewer",
        "priority": 1,
        "sort": 0,
        "userType": "host"
    }
}