/v1/participants

Soft-delete a participant.

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

Soft-deletes a participant. This removes the participant from the event in the Apptoto UI and halts any messages being sent to them. Supply the participant id as a query parameter.

The deleted participant is returned with a state of deleted:

{
  participant: {
    id: 789,
    event_id: 123,
    name: "Fred Smith",
    state: "deleted"
  }
}

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.

Query Params
int32
required

The Apptoto id of the participant to delete.

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