API Reference
  1. Partner API v2.2
  2. Consent

Create Member Consent

post
https://s3partnerapi-staging.solutran.com/2.2/consent

Creates a new member consent record for communication preferences.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The consent creation request.

Request model for creating member consent.

string | null

Optional caller-supplied correlation ID. Returned in response headers and logs for end-to-end tracing.

string | null

Username or system identifier of the user performing the update. Used for audit trail.

int64

Internal S3 account identifier. Optional for requests.

int32
required
1 to 2147483647

The S3 program the account belongs to.

string | null

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

string
required
length ≥ 1
^(PAYER|PROGRAM|GROUP|SUBGROUP)$

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

string
required
length between 1 and 100

ID of the level entity. Required.

string
required
length between 1 and 50

Type of consent - DATA_SHARE, SMS_ALERTS, EMAIL_MARKETING, SEE_BALANCE, etc. Required.

string
required
length ≥ 1

System used for consent - HB, IVR, PSP, CRM, SMS, UHC_Store. Required.

string
required
length ≥ 1
^(EXPLICIT|IMPLICIT)$

How consent was obtained - EXPLICIT, IMPLICIT. Required.

string
required
length between 1 and 50

Device used - Mobile App, Web, Phone. Required.

string
required
length between 1 and 100

User who added consent. Required.

string | null
^(PHONE|EMAIL|ADDRESS)$

Type of contact info - PHONE, EMAIL, ADDRESS. Optional.

string | null

Phone number or email. Required if contactType is provided.

string | null
^(MEMBER_INPUT|SYSTEM_RECORD)$

Source of contact info - MEMBER_INPUT, SYSTEM_RECORD. Optional.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Missing 3 required scopes
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 3 months ago

Did this page help you?