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
    • address object

      An address

      Hide address attributes Show address attributes object
      • city string

        City

      • country string

        Country

      • houseNumber string

        House number

      • street string

        Street

      • zipCode string

        ZIP code

    • birthCity string

      Participant birth city

    • birthCountry string

      Participant birth country

    • contactInformation array[object]

      Contact Information for the participant

      A way of contacting a person, i.e. Phone Number

      Hide contactInformation attributes Show contactInformation attributes object
      • type string

        Type

        Values are phone, mobile, fax, landline, email, team_email, or skype.

      • value string

        Value

    • customerNumber string

      Participant customer number

    • dateOfBirth 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
      • address object

        An address

        Hide address attributes Show address attributes object
        • city string

          City

        • country string

          Country

        • houseNumber string

          House number

        • street string

          Street

        • zipCode string

          ZIP code

      • birthCity string

        Participant birth city

      • birthCountry string

        Participant birth country

      • contactInformation array[object]

        Contact Information for the participant

        A way of contacting a person, i.e. Phone Number

        Hide contactInformation attributes Show contactInformation attributes object
        • type string

          Type

          Values are phone, mobile, fax, landline, email, team_email, or skype.

        • value string

          Value

      • customerNumber string

        Participant customer number

      • dateOfBirth 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 \
 --request POST 'https://api.azav-pilot.de/v1/participants' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"participant":{"id":"\u003cuuid v4\u003e","last_name":"Muster","first_name":"Melanie"}}'
Request example
{
  "participant": {
    "id": "<uuid v4>",
    "last_name": "Muster",
    "first_name": "Melanie"
  }
}
Response examples (201)
{
  "data": {
    "id": "<uuid v4>",
    "last_name": "Muster",
    "first_name": "Melanie"
  }
}