Dispach
HTTP API
POST
/v1/participants

Authorization

bearer
headerAuthorizationBearer <token>

An operator key or the configured token.

Request Body

application/json
  1. body
id*string

The participant id.

Length1 <= length
name?string

A display name, shown to agents beside the id.

Length1 <= length
role?string

What the participant may do: "admin" also assigns agents.

Value in"admin""member"
title?string

A job title, as the team knows the person. Told to an agent answering another member's agent about whom it represents and who is asking. Not a permission.

Length1 <= length <= 120
timezone?string

An IANA timezone, such as "Europe/London". Told to an agent answering another member's agent, so "tomorrow at nine" means the right hour. Refused when the runtime does not know it.

Length1 <= length

Response Body

registered, or updated if the id existed

Example Request
curl -X POST 'http://localhost:7420/v1/participants' \  -H 'Content-Type: application/json' \  -d '{  "id": "string"}'
Example Response
Empty