Set or unset external consent for a client user

Sets or unsets the externally-accepted consent flag for the specified client user. When externalConsentAccepted is true, records that consent was collected externally. When externalConsentAccepted is false, withdraws the externally-accepted consent.

Path Parameters

• clientUserId string required

  The user's internal Upheal UUID or the partner's partnerUserId (external ID) set during user creation. Note - using partnerUserId may result in slightly higher latency due to an additional lookup.

application/json

Request Body required

• externalConsentAccepted boolean required

  Whether consent has been accepted externally.

Responses

• 200
• 400
• 401
• 403
• 404
• 409

---

Consent updated successfully.

application/json

• Schema
• Example (from schema)

---

Schema

• externalConsentAccepted boolean required

  Whether consent has been accepted externally.

{
  "externalConsentAccepted": true
}

Invalid request parameters or user is not a client.

Missing or invalid API key.

Given API key is not allowed to access user with given parameters.

User not found or no consent to withdraw.

Consent already set (when setting externalConsentAccepted to true).

Loading...