Update Consent Status

patch

https://s3partnerapi-staging.solutran.com/2.2/consent/{clientid}/status

Updates the consent status (opt-in/opt-out) for a member filtered by level, levelId, and consentType.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

clientid

string

required

The account identifier.

Body Params

The consent update request.

Request model for updating consent status.

householdId

int64

Internal S3 account identifier. Optional for requests.

programId

int32

required

1 to 2147483647

The S3 program the account belongs to.

clientAccountId

string | null

The client-specific account identifier. Required if Id-Type: Client header is used

level

string

required

length ≥ 1

^(PAYER|PROGRAM|GROUP|SUBGROUP)$

Consent level. Required. Consent level - PAYER, PROGRAM, GROUP, SUBGROUP. Required.

levelId

string

required

length ≥ 1

ID of the level entity. Required.

consentType

string

required

length ≥ 1

The type of consent to filter by (e.g., DATA_SHARE, SMS_ALERTS, EMAIL_MARKETING, SEE_BALANCE, etc. Required. )

status

string

required

length ≥ 1

^(OPTED_IN|OPTED_OUT)$

New status for the consent. e.g., 'OPTED_IN', 'OPTED_OUT'. Required.

updatedSource

string

required

length ≥ 1

System used for the update. Required.

updatedDevice

string

required

length ≥ 1

Device used for the update. Required.

updatedUser

string

required

length ≥ 1

User who performed the update. Required.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error