Export Member

Pending

POST

https://api.mpc.dev.placewise.com/v1/members/{member_id}/exports

API Permit:BL:Api:Members:IndividualExports:Create

API Context:Loyalty Club

Authorizations:UserToken

Starts export of member data in form of zipped set of XLSX documents protected with password that contain member data
(properties, their history and messaging history for member).

When export is finished, an email is sent to notification_email. The notification includes link to the export file and password to it.

The file may be then accessed here

If this endpoint is being accessed in context of authenticated user, the email is inferred from the current user setup.

Query Parameters

Parameter	Type	Required?	Description
notification_email	string	no

Response Body

Key	Type	Description
members_export.password	string	Password to descript the file

Error Responses

Status	Reason
`404`	Member not found

Example

When successful, returns a password to decrypt the file

{
  "member_export": {
    "password": "tvwgKnXVy8vsD9SiuSdVuc9n",
  }
}

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/members/1/exports' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization: Bearer ' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

Example

{}

Cancel Transaction

Download Member Export

Export Member

Query Parameters#

Response Body#

Error Responses#

Example#

Request

Request Code Samples

Responses

Query Parameters

Response Body

Error Responses

Example