Skip to content
Connect API
/
/Leads

Magicline Connect API (1.0.0)

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/

Languages
Servers
Generated server url

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

Mock server

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

Campaigns

List your marketing campaigns

Operations

Terminal

/terminal

Operations

TrialSessions

Allow prospects to book a trial session

Operations

Tenant

Tenant information

Operations

Referral

Additional referral information for member creation

Operations

Image

Allow prospect to upload image

Operations

Promotions

Getting information about external promotion participation

Operations

AddressData

/addressdata

Operations

ContractVoucher

/contractvoucher

Operations

Validation

/validation

Operations

Contracts

Cancel contracts

Operations

CreditCard Tokenization

Store credit cards for new members

Operations

BankAccount

Operations

FeatureCheck

Operations

I18n

Operations

Leads

Operations

Create leads for prospective customers

Request

Bodyapplication/jsonrequired
additionalAddressInformationstring[ 0 .. 300 ] characters

addition for Spain

citystring[ 0 .. 300 ] characters
Example: "Hamburg"
communicationPreferencesArray of objects(CustomerCommunicationPreferencesData)

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

countryCodestring[ 0 .. 300 ] characters
Example: "DE"
dateOfBirthstring(date)
doorstring[ 0 .. 300 ] characters

addition for Spain

emailstring[ 0 .. 300 ] characters
firstnamestring[ 0 .. 100 ] charactersrequired
firstname2string[ 0 .. 100 ] characters

addition for Turkey

floorstring[ 0 .. 300 ] characters

addition for Spain

genderstring

User will be assigned as UNISEX if no gender is set.

Enum"MALE""FEMALE""UNISEX"
houseNumberstring[ 0 .. 100 ] characters
Example: "3-4"
lastnamestring[ 0 .. 100 ] charactersrequired
lastname2string[ 0 .. 100 ] characters

addition for Spain

localestring[ 0 .. 300 ] characters

locale of customer as ISO 639-1 two-letter language and country code (e.g. es_ES or de_DE)

notesstring[ 0 .. 1000 ] characters
Example: "any notes about this lead"
phonestring[ 0 .. 300 ] characters
portalstring[ 0 .. 300 ] characters

addition for Spain

privacyConfigurationobject(PublicApiPrivacyConfigurationDto)

Data privacy configuration for marketing purposes

provincestring[ 0 .. 300 ] characters

addition for southern Europe/US countries (e.g. Madrid, California)

provinceCodestring[ 0 .. 300 ] characters

addition for US state abbreviation (e.g. CA)

sourceCampaignIdinteger(int64)
stairwaystring[ 0 .. 300 ] characters

addition for Spain

streetstring[ 0 .. 300 ] characters
Example: "Raboisen"
streetBlockstring[ 0 .. 300 ] characters

addition for Spain

streetTypestring[ 0 .. 300 ] characters

addition for Spain (e.g. calle)

studioIdinteger(int64)required
taxIdstring[ 0 .. 300 ] characters

addition for Spain and Italy

zipCodestring[ 0 .. 100 ] characters
Example: 22099
curl -i -X POST \
  https://connectdemo.api.magicline.com/connect/v1/lead \
  -H 'Content-Type: application/json' \
  -d '{
    "additionalAddressInformation": "string",
    "city": "Hamburg",
    "communicationPreferences": [
      {
        "activeCommunicationChannels": [
          "LETTER"
        ],
        "messageCategoryId": 0
      }
    ],
    "countryCode": "DE",
    "dateOfBirth": "2019-08-24",
    "door": "string",
    "email": "string",
    "firstname": "string",
    "firstname2": "string",
    "floor": "string",
    "gender": "MALE",
    "houseNumber": "3-4",
    "lastname": "string",
    "lastname2": "string",
    "locale": "string",
    "notes": "any notes about this lead",
    "phone": "string",
    "portal": "string",
    "privacyConfiguration": {
      "email": true,
      "letter": true,
      "mySportsMessage": true,
      "phone": true,
      "textMessage": true
    },
    "province": "string",
    "provinceCode": "string",
    "sourceCampaignId": 0,
    "stairway": "string",
    "street": "Raboisen",
    "streetBlock": "string",
    "streetType": "string",
    "studioId": 0,
    "taxId": "string",
    "zipCode": 22099
  }'

Responses

OK

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"

Returns information about an existing lead record

Request

Path
uuidstring(uuid)required
curl -i -X GET \
  'https://connectdemo.api.magicline.com/connect/v1/lead/{uuid}'

Responses

OK

Body*/*
addressobject(CommonTrialSessionLeadAddressDto)
communicationPreferencesArray of objects(CustomerCommunicationPreferencesData)

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

countryOfBirthstring
Enum"UNDEFINED""AC""AD""AE""AF""AG""AI""AL""AM""AN"
Example: "FR"
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"
dateOfBirthstring(date)
Example: "1985-05-29"
emailstring[ 0 .. 300 ] characters
Example: "mm@test.de"
firstnamestring[ 0 .. 100 ] charactersrequired
Example: "Max"
genderstring
Enum"MALE""FEMALE""UNISEX"
Example: "MALE"
lastnamestring[ 0 .. 100 ] charactersrequired
Example: "Mustermann"
phonestring[ 0 .. 300 ] characters
Example: "+49 40 123 555"
placeOfBirthstring[ 0 .. 300 ] characters
Example: "Rom"
privacyConfigurationobject(PublicApiPrivacyConfigurationDto)

Data privacy configuration for marketing purposes

secondFirstnamestring[ 0 .. 100 ] characters
Example: "Martin"
secondLastnamestring[ 0 .. 100 ] characters
Example: "Muster"
studioIdinteger(int64)

Only set if lead is fetched

taxIdstring[ 0 .. 300 ] characters
Example: "56982134w"

Studios

Operations

Previews

Operations