Start

Pending

POST

https://api.mpc.dev.placewise.com/v1/members/programs/{program_id}/registrations/start

API Permit:BL:Api:Members:Programs:Registrations:Start

API Context:Loyalty Club

Authorizations:Token

Allows to register (existing or non-existing) member in given Program by e-mail.

Sends an email message that contains a link that needs to be clicked by member in order to confirm the registration.
The link is active for 24 hours.

URL Parameters

Parameter	Description	Type
id	Program's ID	integer

Body Parameters

Parameter	Type	Required?	Description
member.email	string (email)	yes
member.consents	object	no	Member's consents (similar to Member's consents JSON model)

Response Body

When successful, returns an empty JSON object.

Error Responses

Status	Reason
`404`	Program does not exist

Specific Validation Errors

Key	Error
`program_id`	`cannot_register_to_this_program`
`member.email`	`already_belongs_to_program`

Example

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/programs/1/registrations/start' \
--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

{}

Destroy Member

Confirm

Start

URL Parameters#

Body Parameters#

Response Body#

Error Responses#

Specific Validation Errors#

Example#

Request

Request Code Samples

Responses

URL Parameters

Body Parameters

Response Body

Error Responses

Specific Validation Errors

Example