7x Developer Portal & API Documentation

Creates or updates a user's notification channel preferences and consent flags. Controls SMS, email, WhatsApp, and push behavior used by downstream notification flows.

Request builder

POST

/api/v1/Notifications/preferences

Access Token

api-versionstring

*object

sourcestring

isSMSPreferredboolean

isWhatsappPreferredboolean

isEmailPreferredboolean

isPushNotificationPreferredboolean

isConsentGivenboolean

preferredLanguagestring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Notifications/preferences" \  -H "Content-Type: application/json" \  -d '{}'

{  "message": "string",  "payload": "string",  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Creates or updates a user's notification channel preferences and consent flags. Controls SMS, email, WhatsApp, and push behavior used by downstream notification flows.

Request builder

POST

/api/v1/Notifications/preferences

Access Token

api-versionstring

*object

sourcestring

isSMSPreferredboolean

isWhatsappPreferredboolean

isEmailPreferredboolean

isPushNotificationPreferredboolean

isConsentGivenboolean

preferredLanguagestring

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

source?Source

Value in

"Web"
"Mobile"

isSMSPreferred?boolean

isWhatsappPreferred?boolean

isEmailPreferred?boolean

isPushNotificationPreferred?boolean

isConsentGiven?boolean

preferredLanguage?string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/Notifications/preferences" \  -H "Content-Type: application/json" \  -d '{}'

{  "message": "string",  "payload": "string",  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  },  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

source?Source

Value in

"Web"
"Mobile"

isSMSPreferred?boolean

isWhatsappPreferred?boolean

isEmailPreferred?boolean

isPushNotificationPreferred?boolean

isConsentGiven?boolean

preferredLanguage?string

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`