Appointment, bookable appointment and slots operations
Magicline Open API
/API reference
/- Get contract idle period by id
Get customer's contract data
Create contract cancelation amendment
Get studio's contract cancelation reason data
withdraw cancelation of contract
Get the idle period configuration of the contract
Validate an idle period request
Get the idle periods of the contract
Create a contract idle period amendment
Update a contract idle period
Withdraw a contract idle period
Get additional modules
Get purchasable additional modules
Validate an additional module contract request
Purchase an additional module contract
Get an additional module contract
Create additional module contract cancelation amendment
withdraw cancelation of the additional module contract
Get contract's remaining idle periods
Get preview of an updated idle period charges and fees
Get contract idle period...
Magicline API (1.10.0)
- Appointment, bookable appointment and slots operations
- Redeem checkin vouchers
- Class and slots operations
- Cross studio operations
- Get customers and contracts
- Retrieve customer accounting details
- Retrieve customer communication details
- Get device information
- Employee operations
- Debt collection operations
- Leads operations
- Manage membership contracts
- Membership operations
- Payment operations
- Get studio information
- Get trial offers information
Download OpenAPI description
Languages
Servers
Demo tenant
https://open-api-demo.open-api.magicline.com/
Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/
Request
Required Scopes: MEMBERSHIP_SELF_SERVICE_IDLE_PERIOD_WRITE
Create a contract idle period amendment. When the amendment is accepted, it will become an idle period. ATTENTION: Please see https://developer.magicline.com/apis/openapi/general-information#multipartform-data-requests
Security
ApiKeyAuth
Represents an idle period create request
Represents the temporal unit of an idle period
| Enum Value | Description |
|---|---|
| MONTH | Represents a monthly temporal unit of the idle period. Can be used for month pickers only. Supports only full months. |
| WEEK | Represents a weekly temporal unit of the idle period. Can be used for week pickers only. Supports only full weeks. |
| DAY | Represents a daily temporal unit of the idle period. Can be used for day pickers only. |
Example: "WEEK"
Duration term of the idle period. The field is related to the temporal unit
Example: 1
If true, the idle period has no defined end date. In that case, termValue and temporalUnit are empty.
Example: true
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/idle-periods
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/memberships/{contractId}/self-service/idle-periods
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/idle-periods' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-F 'data[startDate]=2019-08-24' \
-F 'data[temporalUnit]=WEEK' \
-F 'data[termValue]=1' \
-F 'data[unlimited]=true' \
-F 'data[reasonId]=1' \
-F document=stringResponse
application/json
{ "id": 203, "startDate": "2019-08-24", "endDate": "2019-08-24", "reason": "Vacation", "fee": { "amount": 20, "currency": "EUR" }, "unlimited": false, "documentUrl": "string", "state": "PENDING_VERIFICATION" }
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/idle-periods/{idlePeriodId}
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/memberships/{contractId}/self-service/idle-periods/{idlePeriodId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/idle-periods/{idlePeriodId}' \
-H 'X-API-KEY: YOUR_API_KEY_HERE'Response
application/json
{ "id": 203, "startDate": "2019-08-24", "endDate": "2019-08-24", "reason": "Vacation", "fee": { "amount": 20, "currency": "EUR" }, "unlimited": false, "documentUrl": "string", "state": "PENDING_VERIFICATION" }
Bodymultipart/form-data
Represents an idle period update request
Represents the temporal unit of an idle period
| Enum Value | Description |
|---|---|
| MONTH | Represents a monthly temporal unit of the idle period. Can be used for month pickers only. Supports only full months. |
| WEEK | Represents a weekly temporal unit of the idle period. Can be used for week pickers only. Supports only full weeks. |
| DAY | Represents a daily temporal unit of the idle period. Can be used for day pickers only. |
Example: "WEEK"
Duration term of the idle period. The field is related to the temporal unit
Example: 1
If true, the idle period has no defined end date. In that case, termValue and temporalUnit are empty.
Example: true
- Demo tenant
https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/idle-periods/{idlePeriodId}
- Mock server
https://redocly.sportalliance.com/_mock/apis/magicline/openapi/openapi/v1/memberships/{contractId}/self-service/idle-periods/{idlePeriodId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://open-api-demo.open-api.magicline.com/v1/memberships/{contractId}/self-service/idle-periods/{idlePeriodId}' \
-H 'Content-Type: multipart/form-data' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-F 'data[startDate]=2019-08-24' \
-F 'data[temporalUnit]=WEEK' \
-F 'data[termValue]=1' \
-F 'data[unlimited]=true' \
-F 'data[reasonId]=1' \
-F 'data[endDate]=2025-12-31' \
-F document=stringResponse
application/json
{ "id": 203, "startDate": "2019-08-24", "endDate": "2019-08-24", "reason": "Vacation", "fee": { "amount": 20, "currency": "EUR" }, "unlimited": false, "documentUrl": "string", "state": "PENDING_VERIFICATION" }