Placewise API

Update Cars Configuration

PUT

https://api.mpc.dev.placewise.com/v1/cars/management/configuration

API Permit:Cars:Api:Management:Configuration:Update

API Context:Loyalty Club

Authorizations:UserToken

Updates cars configuration.

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Body Params application/json

configuration

object (CarsConfiguration)

required

maximum_cars_per_member

integer

required

How many cars member may register

>= 1<= 10

Default:

Example:

car_validity_days

integer

required

For how many days cars are treated as active

>= 1<= 3650

Example:

365

expiration_warning_notification_days

integer

required

How many days before car expiration a warning notification should be shown to user

>= 1<= 365

Example:

Example

{
    "configuration": {
        "maximum_cars_per_member": 2,
        "car_validity_days": 365,
        "expiration_warning_notification_days": 7
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.mpc.dev.placewise.com/v1/cars/management/configuration' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configuration": {
        "maximum_cars_per_member": 2,
        "car_validity_days": 365,
        "expiration_warning_notification_days": 7
    }
}'

Responses

🟢200Success

application/json

Body

configuration

object (CarsConfiguration)

required

maximum_cars_per_member

integer

required

How many cars member may register

>= 1<= 10

Default:

Example:

car_validity_days

integer

required

For how many days cars are treated as active

>= 1<= 3650

Example:

365

expiration_warning_notification_days

integer

required

How many days before car expiration a warning notification should be shown to user

>= 1<= 365

Example:

Example

{
    "configuration": {
        "maximum_cars_per_member": 2,
        "car_validity_days": 661,
        "expiration_warning_notification_days": 359
    }
}

🟠422Invalid Parameters

Modified at 2024-05-22 20:22:21

Show Cars Configuration

Introduction