Archive Collection

Pending

PUT

https://api.mpc.dev.placewise.com/v3/{loyalty_club_slug}/offers/collections/{collection_id}/archive

API Permit:Offers:Api:Collections:Destroy

API Context:Loyalty Club

Authorizations:UserToken

Archives (performs soft-delete) given collection.

Body Parameters

Key	Type	Description
collection	Collection	See Collection - except for read-only attributes

Example

When successful, returns an empty object:

{}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

collection_id

integer

required

Example:

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:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.mpc.dev.placewise.com/v3/infinity-mall/offers/collections/1/archive' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Modified at 2024-05-07 15:48:47

Update Collection

Update Collections Order

Archive Collection

Body Parameters#

Example#

Request

Request samples

Responses

Body Parameters

Example