Activate program member

Moves the member to ACTIVE status and records a vl.member.activated activity. No request body. Returns 404 when the program or member does not exist. Returns 400 (invalid_state_transition) when the member cannot be activated from its current state.

POST /v2/loyalties/programs/{programId}/members/{memberId}/activate

Activate program member

cURL

curl --request POST \
  --url {protocol}://{host}/v2/loyalties/programs/{programId}/members/{memberId}/activate \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

200

{
  "id": "<string>",
  "customer_id": "<string>",
  "program_id": "<string>",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "object": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

{
  "code": 123,
  "key": "<string>",
  "message": "<string>",
  "details": "<string>",
  "request_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>"
}

Authorizations

X-App-Id & X-App-TokenbearerAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

programId · string · required

Unique loyalty program ID (format lprg_[a-f0-9]+).

Pattern: ^lprg_[a-f0-9]+$

memberId · string · required

Program member ID (format lmbr_[a-f0-9]+).

Pattern: ^lmbr_[a-f0-9]+$

Response

200

application/json

The activated member (without cards).

A loyalty program member.

id · string · required

Unique member ID.

Pattern: ^lmbr_[a-f0-9]+$

customer_id · string · required

Unique Voucherify ID of the customer enrolled as this member.

Pattern: ^cust_[a-zA-Z0-9]+

program_id · string · required

Unique Voucherify ID of the loyalty program the member belongs to.

Pattern: ^lprg_[a-f0-9]+$

status · enum<string> · required

Current member status. INACTIVE member can't earn points or redeem rewards.

Available options: ACTIVE, INACTIVE, DELETED

metadata · object · required

Free-form metadata attached to the member (empty object when none).

created_at · string<date-time> · required

Timestamp when the member was created (ISO 8601).

updated_at · string<date-time> | null · required

Timestamp when the member was last updated (ISO 8601), or null if never updated.

object · string · required

Object type marker, always member.

Allowed value: "member"