Connect API

API reference

Book a trial session

Magicline Connect API (1.0.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Scope of this API

This API can be used to integrate Magicline operations into third party clients like websites or apps.

Following operations are supported

Online contract conclusion
Trial session slot booking
Lead creation

Download OpenAPI description

connectapi.json

connectapi.yaml

Overview

URL

https://developer.sportalliance.com/

Servers

Generated server url

https://connectdemo.api.magicline.com/

Mock server

https://redocly.sportalliance.com/_mock/apis/magicline/connectapi/connectapi/

Campaigns
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

List your marketing campaigns

Operations

Terminal
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

/terminal

Operations

TrialSessions
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Allow prospects to book a trial session

Operations

Get free slots for a trial session

Request

Returns free slots for a studio where a trial session appointment can be booked.

Query

studioIdinteger(int64)required

Example: studioId=1

startDatestring(date)required

Example: startDate=2021-05-15

endDatestring(date)required

Example: endDate=2021-05-21

curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/trialsession?studioId=1&startDate=2021-05-15&endDate=2021-05-21'

Responses

Body*/*

bookingWithoutResourcesAllowedboolean

true: Customer can decide if a trainer is needed, false: Trainer is always mandatory (trainerRequired)

descriptionstring

Short description how the trial session looks like

namestring

Display name of trial session

slotsArray of objects(ConnectApiBookableItemSlotDto)

Book a trial session

Request

Book a free slot. Might return errorCode CONFLICT if configured resources are overbooked for this slot. In this case its advised to reload free slots and let the user select a different slot. If you get a validation error make sure all required fields are filled. Required fields are returned by the /config/validation endpoint.

Bodyapplication/jsonrequired

leadCustomerobject(CommonTrialSessionLeadCustomerDto)required

leadCustomer.addressobject(CommonTrialSessionLeadAddressDto)

leadCustomer.communicationPreferencesArray of objects(CustomerCommunicationPreferencesData)

Communication preferences for the customer. If specified, the list must contain an element for each message category.

leadCustomer.countryOfBirthstring

Enum"UNDEFINED""AC""AD""AE""AF""AG""AI""AL""AM""AN"

Example: "FR"

leadCustomer.customerUUIDstring[ 0 .. 300 ] characters

Should only be set if booking page has been called with URL param identityToken. If no lead exists with this UUID a new one will be created.

Example: "2340b1cc-3fe7-4f81-8eca-f92181dd2bb4"

leadCustomer.dateOfBirthstring(date)

Example: "1985-05-29"

leadCustomer.emailstring[ 0 .. 300 ] characters

Example: "mm@test.de"

leadCustomer.firstnamestring[ 0 .. 100 ] charactersrequired

Example: "Max"

leadCustomer.genderstring

Enum"MALE""FEMALE""UNISEX"

Example: "MALE"

leadCustomer.lastnamestring[ 0 .. 100 ] charactersrequired

Example: "Mustermann"

leadCustomer.phonestring[ 0 .. 300 ] characters

Example: "+49 40 123 555"

leadCustomer.placeOfBirthstring[ 0 .. 300 ] characters

Example: "Rom"

leadCustomer.privacyConfigurationobject(PublicApiPrivacyConfigurationDto)

Data privacy configuration for marketing purposes

leadCustomer.secondFirstnamestring[ 0 .. 100 ] characters

Example: "Martin"

leadCustomer.secondLastnamestring[ 0 .. 100 ] characters

Example: "Muster"

leadCustomer.studioIdinteger(int64)

Only set if lead is fetched

leadCustomer.taxIdstring[ 0 .. 300 ] characters

Example: "56982134w"

notestring[ 0 .. 300 ] characters

Example: "become fit"

participantsinteger(int32)

Example: 2

referralCodestring[ 0 .. 300 ] characters

Example: "ABCXYZ"

referrerIdinteger(int64)

Example: 10

sourceCampaignIdinteger(int64)

Example: 2

startDateTimestring(date-time)required

Example: "2019-04-15T07:00:00.000Z"

studioIdinteger(int64)required

Example: 1

trainerRequiredbooleanrequired

Depends on bookingWithoutResourcesAllowed

Example: true

curl -i -X POST \
  https://connectdemo.api.magicline.com/connect/v1/trialsession/book \
  -H 'Content-Type: application/json' \
  -d '{
    "leadCustomer": {
      "address": {
        "city": "Hamburg",
        "country": "DE",
        "details": {
          "additionalInformation": "string",
          "block": "string",
          "buildingName": "string",
          "cityPart": "string",
          "district": "string",
          "door": "string",
          "floor": "string",
          "portal": "string",
          "province": "string",
          "provinceCode": "string",
          "secondStreet": "string",
          "stairway": "string",
          "streetType": "string"
        },
        "houseNumber": "1b",
        "street": "Heinrichstraße",
        "zip": 20095
      },
      "communicationPreferences": [
        {
          "activeCommunicationChannels": [
            "LETTER"
          ],
          "messageCategoryId": 0
        }
      ],
      "countryOfBirth": "FR",
      "customerUUID": "2340b1cc-3fe7-4f81-8eca-f92181dd2bb4",
      "dateOfBirth": "1985-05-29",
      "email": "mm@test.de",
      "firstname": "Max",
      "gender": "MALE",
      "lastname": "Mustermann",
      "phone": "+49 40 123 555",
      "placeOfBirth": "Rom",
      "privacyConfiguration": {
        "email": true,
        "letter": true,
        "mySportsMessage": true,
        "phone": true,
        "textMessage": true
      },
      "secondFirstname": "Martin",
      "secondLastname": "Muster",
      "studioId": 0,
      "taxId": "56982134w"
    },
    "note": "become fit",
    "participants": 2,
    "referralCode": "ABCXYZ",
    "referrerId": 10,
    "sourceCampaignId": 2,
    "startDateTime": "2019-04-15T07:00:00.000Z",
    "studioId": 1,
    "trainerRequired": true
  }'

Responses

Body*/*

customerNumberstring

Customer number of prospect

idinteger(int64)required

Id of current data block. See name field parameter or name of Dto!

uuidstring(uuid)

Can be used to execute follow up actions (Booking of appointment, singing a contract with this exact customer.

Example: "2340b1cc-3fe7-4f81-8eca-f92181dd2bb4"

Get mandatory field configuration

Request

Returns the configuration which needs to be considered e.g. for form fields and their validation.

Query

studioIdinteger(int64)required

Example: studioId=1

curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/trialsession/config/validation?studioId=1'

Responses

Body*/*

addressModestring

Defines validation mode for full address. INACTIVE: hide it, OPTIONAL: Show it as optional form field, MANDATORY: Show it as mandatory form field.