GuidesAPI Reference
Log In
API Reference

/participants/{participant_id}/events/

Adds a list of the different event types for a participant.

It will not duplicate events.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Serializer for participant events.

Used to get and set event types for a participant. The event types are defined in the ParticipantEvent model.

event_types
array of strings
required
length ≥ 1
event_types*
Allowed:

  • Completed Setup - Completed Setup
  • eDocument Agreement - eDocument Agreement
  • Viewed Documents - Viewed Documents
  • Skipped Guided Portfolio - Skipped Guided Portfolio
  • Remove eDocument Agreement - Remove eDocument Agreement
  • Opt Out - Opt Out

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
401

Unauthorized: Missing or invalid authentication

403

Forbidden: Insufficient permissions or scopes

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