Skip to main content
POST
/
create-participant
curl --request POST \
  --url https://api.heify.com/create-participant \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "tag": "juan pedro",
  "metadata": {
    "role": "manager",
    "language": "español",
    "empresa": "leroy"
  }
}
'
{
  "data": {
    "message": "Participant created successfully",
    "participant": {
      "participant_id": "1f77a5f5-ac38-42c6-999d-45f02d11d121",
      "tag": "juan pedro",
      "metadata": {
        "role": "manager",
        "language": "español",
        "empresa": "leroy"
      },
      "created_at": "2026-03-21T13:23:18.069124+00:00",
      "updated_at": "2026-03-21T13:23:18.088360+00:00"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.heify.com/llms.txt

Use this file to discover all available pages before exploring further.

For the full Participant data model, see Participant.
tag is trimmed of leading and trailing whitespace automatically.
metadata values are always stored as strings, regardless of the input type. See Participant — metadata.
Each account is limited to 200 participants. Returns 400 if the limit is reached.

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
tag
string
required

Label for this participant. Max 100 characters. Leading and trailing whitespace is stripped automatically.

​
metadata
object

Optional key-value pairs. Max 10 keys; keys ≤50 characters, values ≤250 characters. All values are stored as strings regardless of input type.

Response

201 - application/json

Participant created successfully.

​
data
object