Get trial offer config

Deprecated

Required Scopes: `TRIAL_OFFER_READ` Get trial offer config by config id

Endpoint

GET /v1/trial-offers/config/{configId}

Path Parameters

configId required integer (int64)

Id of the trial offer configuration

Responses

OK

Response Body application/json

The trial offer configuration

id integer(int64) required

The id of the trial offer config

Example:  1
name required

The name of the trial offer config

Example:  "Probeangebot"
preventMultipleBookingsTerm required

Represents a term

value integer(int32) required

The value of the term

Example:  2
unit required

Represents a temporal unit

Allowed values:
DAY Represents a day unit
WEEK Represents a week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
contingent integer(int32) required

How often a lead can book the trial offer

Example:  2
confirmationOfBookingTerm

Represents a term with minutes

value integer(int32) required

The value of the term with minutes

Example:  2
unit required

Represents a temporal unit with minutes

Allowed values:
MINUTES Represents a minutes unit
HOURS Represents a hours unit
DAY Represents day unit
WEEK Represents week unit
MONTH Represents month unit
YEAR Represents year unit
Example:  "WEEK"
allowBookingForLeads required

Whether booking is allowed for leads

Example:  true
leadDataConfig required

The trial offer lead data configuration

trialOfferLeadDataConfigId integer(int64) required

The ID of the trial offer lead data config

Example:  1
genderMode required

Represents the mode of an input field

Allowed values:
INACTIVE The input is disabled
OPTIONAL The input is optional
MANDATORY The input is mandatory
Example:  "INACTIVE"
dateOfBirthMode required

Represents the mode of an input field

Allowed values:
INACTIVE The input is disabled
OPTIONAL The input is optional
MANDATORY The input is mandatory
Example:  "INACTIVE"
telephoneMode required

Represents the mode of an input field

Allowed values:
INACTIVE The input is disabled
OPTIONAL The input is optional
MANDATORY The input is mandatory
Example:  "INACTIVE"
addressMode required

Represents the mode of an input field

Allowed values:
INACTIVE The input is disabled
OPTIONAL The input is optional
MANDATORY The input is mandatory
Example:  "INACTIVE"
Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"