/v1/participants

Add a participant to an existing event.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Adds a participant to an existing event. Supply event_id, plus either a contact_id (to add an existing contact) or at least one of name, phone, or email (to create a participant from raw details).

The request body should look like the following:

{
  event_id: 123,
  name: "Fred Smith",
  phone: "+16505551212",
  email: "[email protected]"
}

To add an existing contact instead, pass its contact_id. The contact's details are used for the participant; name, phone, and email are optional overrides.

{
  event_id: 123,
  contact_id: 456
}

The created participant is returned in the same shape as /v1/participants:

{
  participant: {
    id: 789,
    event_id: 123,
    name: "Fred Smith",
    phone: "+16505551212",
    normalized_phone: "+16505551212",
    email: "[email protected]",
    state: "initial"
  }
}

OAuth scope

Calls authenticated with an OAuth 2.0 bearer token must include the events:write scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.

Form Data
int32
required

The Apptoto id of the event to add the participant to.

int32

The Apptoto id of an existing contact to add as a participant. When provided, name, phone, and email are optional overrides of the contact's details.

string

The participant's name. Required unless phone or email is provided.

string

The participant's phone number. Required unless name or email is provided.

string

The participant's email address. Required unless name or phone is provided.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!