Providers
Provider management endpoints
Authorizations
AuthorizationstringRequired
API Key with rest-api:* scope
Body
namestring · min: 2 · max: 100Required
service_idinteger | nullableOptional
key_valid_minutesinteger · min: 5 · max: 525960Required
Required field, minimum 5 minutes
user_select_modebooleanOptionalDefault:
falseuser_select_requiredinteger · min: 1 · max: 50OptionalDefault:
1user_select_allow_duplicatesbooleanOptionalDefault:
falseuser_time_selection_enabledbooleanOptionalDefault:
falseone_time_usebooleanOptionalDefault:
Cannot be combined with expiry_on_first_use
falseexpiry_on_first_usebooleanOptionalDefault:
Cannot be combined with one_time_use
falsehwid_limitinteger · min: 1 · max: 100OptionalDefault:
1streak_enabledbooleanOptionalDefault:
falsestreak_bonus_minutes_per_dayinteger · min: 1 · max: 1440OptionalDefault:
5streak_max_bonus_hoursinteger · min: 1 · max: 168OptionalDefault:
24Responses
201
Provider created
application/json
400
Validation error or invalid combination (one_time_use + expiry_on_first_use)
401
Unauthorized
post
/providersAuthorizations
AuthorizationstringRequired
API Key with rest-api:* scope
Path parameters
providerIdintegerRequired
Body
namestring · min: 2 · max: 100Optional
service_idinteger | nullableOptional
key_valid_minutesinteger · min: 5 · max: 525960Optional
user_select_modebooleanOptional
user_select_requiredinteger · min: 1 · max: 50Optional
user_select_allow_duplicatesbooleanOptional
user_time_selection_enabledbooleanOptional
user_time_selection_optionsobject[] | nullableOptional
one_time_usebooleanOptional
expiry_on_first_usebooleanOptional
is_activebooleanOptional
hwid_limitinteger · min: 1 · max: 100Optional
streak_enabledbooleanOptional
streak_bonus_minutes_per_dayinteger · min: 1 · max: 1440Optional
streak_max_bonus_hoursinteger · min: 1 · max: 168Optional
Responses
200
Provider updated
No content
put
/providers/{providerId}200
Provider updated
No content
Last updated