Create Loyalty Advice
POST/client/users/:correlation_id/advices/loyalty
Creates a Loyalty Advice for the current session's account.
Request
Body
| Field | Type | Required | Description | Allowed Values |
|---|---|---|---|---|
entity | string | Yes | The scope of the lock to apply. Currently only account-level locks are supported. | ACCOUNT |
context | string | Yes | The type of action to restrict. Currently only redemption locks are supported. | REDEMPTION |
reason | string | No | A free-text explanation of why the lock is being applied (e.g. for audit purposes). | any string |
Response
Returns the created lock object.
| Attribute | Type | Description |
|---|---|---|
accountId | string | The unique identifier of the member account. |
entity | string | The scope of the lock that was applied. |
context | string | The action that is now restricted. |
posture | string | The enforcement action in effect. |
startTimestamp | string | When the lock was applied, in ISO 8601 format. |
endTimestamp | string | When the lock is scheduled to expire, in ISO 8601 format. |
label | string | A human-readable description of the lock. |
channel | string | The channel that created the lock. |
source | string | The system that owns this lock record. |
Request
Responses
- 200
200 - Redemption Lock Applied