Create Participant

POST /v1/participants
application/json

Body

New Participant Params

  • participant object Required

    A potential/future/current/past participant

    Hide participant attributes Show participant attributes object
    • birthCity string

      Participant birth city

    • birthCountry string

      Participant birth country

    • customerNumber string

      Participant customer number

    • date_of_birth string(date)

      Birth date

    • email string(email) Required

      Email address

    • firstName string

      Participant first name

      Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

    • gender string

      Participant gender

      Values are diverse, female, or male.

    • id integer

      Participant ID

    • insertedAt string(date-time)

      Creation timestamp

    • internalCustomerNumber string

      Participant internal customer number

    • lastName string

      Participant last name

      Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

    • marketingChannel string

      Participant marketing channel

    • preferredName string

      Participant preferred name

    • salutation string

      Participant salutation

    • status string

      Participant status

      Values are lead, future, active, past, dropout, or archived.

    • updatedAt string(date-time)

      Update timestamp

Responses

  • 201 application/json

    Participant response

    Hide response attribute Show response attribute object
    • data object

      A potential/future/current/past participant

      Hide data attributes Show data attributes object
      • birthCity string

        Participant birth city

      • birthCountry string

        Participant birth country

      • customerNumber string

        Participant customer number

      • date_of_birth string(date)

        Birth date

      • email string(email) Required

        Email address

      • firstName string

        Participant first name

        Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

      • gender string

        Participant gender

        Values are diverse, female, or male.

      • id integer

        Participant ID

      • insertedAt string(date-time)

        Creation timestamp

      • internalCustomerNumber string

        Participant internal customer number

      • lastName string

        Participant last name

        Format should match the following pattern: [a-zA-Z][a-zA-Z0-9_]+.

      • marketingChannel string

        Participant marketing channel

      • preferredName string

        Participant preferred name

      • salutation string

        Participant salutation

      • status string

        Participant status

        Values are lead, future, active, past, dropout, or archived.

      • updatedAt string(date-time)

        Update timestamp

POST /v1/participants
curl \
 -X POST https://api.azav-pilot.de/v1/participants \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"participant":{"first_name":"Melanie","id":"\u003cuuid v4\u003e","last_name":"Muster"}}'
Request example
{
  "participant": {
    "first_name": "Melanie",
    "id": "<uuid v4>",
    "last_name": "Muster"
  }
}
Response examples (201)
{
  "data": {
    "first_name": "Melanie",
    "id": "<uuid v4>",
    "last_name": "Muster"
  }
}