m2pfintech
API LibraryCard Preferences

Process Opt-In

Processes a customer opt-in or opt-out preference for a specific operation. The operation is specified in the URL path parameter and represents the feature being opted in or out of. The optedIn field controls whether the customer is opting in (true) or opting out (false). Supports audit fields for tracking who made the change.

POST
/preference/{operation}/optIn

Authorization

tenantAuth
tenant<token>

The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.

In: header

Path Parameters

operation*string

The specific operation or feature to opt in or out of.

Header Parameters

tenant*string

The DCMS client or tenant name for multi-tenant isolation.

Request Body

application/json

entityId*string

Customer entity identifier.

kitNo*string

Kit number of the card for the opt-in preference.

optedIn*boolean

True to opt in, false to opt out.

channel?string

Channel through which the opt-in was initiated.

creator?string

Identifier of the user creating the opt-in record.

changer?string

Identifier of the user making the change.

approver?string

Identifier of the user approving the opt-in.

Response Body

application/json

curl -X POST "https://api.dcms.example.com/v1/preference/sms-alerts/optIn" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "entityId": "1232443",    "kitNo": "6768767",    "optedIn": false,    "channel": "SMS",    "creator": "test",    "changer": "test",    "approver": "test"  }'
{
  "result": true,
  "exception": null,
  "pagination": null
}