Skip to main content

Unenroll User

Remove a user and all their linked cards from Visa's Offers Platform.

When to Use​

▾

Use this endpoint when:

  • A user requests to opt out of the offers program
  • Cleaning up inactive user records

How to Use​

▾
Endpoint
DELETE/v3/vop/unenroll-user

Step 1: Get the User ID​

▾

Use the RM-issued userId returned by Enroll User.

Step 2: Send the DELETE Request​

▾

DELETE /v3/vop/unenroll-user with the userId in the body. Signed authentication headers required.

Step 3: Verify the Response​

▾

A "SUCCESS" code confirms the user (and all linked cards) were removed.


Request Parameters​

▾
userIdSTRINGrequired

RM-issued user ID returned by [Enroll User](./enroll-user).

Example: "1699331101742889953"


Response Parameters​

▾
codeSTRING

`"SUCCESS"` if the user was removed. Otherwise returns an error code. See [Error Codes](../error-codes).

Example: "SUCCESS"