updateConsentDefinition()


Updates the state of broadcaster’s consent definition. By default it will return terms and privacy consents, broadcaster_terms or broadcaster_marketing are set by broadcaster.

Parameters:

Name Type Description
publisherToken string Your publisher token
name string Consent name (one of: terms**, privacy**, broadcaster_terms, broadcaster_marketing)
version string Unique version identifier for the consent text
value string The value of the consent in its current version (URL for terms/privacy/broadcaster_terms, text for broadcaster_marketing)

- only available for broadcasters with Cleeng Terms/Privacy replaced by their own

- required parameter

Response Parameters:

Name Type Description
success boolean Information about success of update

Error Codes:

Code Description
3 Invalid publisher token
23 User does not exist
25 Broadcaster is not allowed to update platform consents

Request:

{
    "method": "updateConsentDefinition",
    "params": {
        "publisherToken": "bC4TVNJYH1WTAErOxcpjl1H7fmAKZsIK0rKKtp5TdMg0RmIg",
        "name": "broadcaster_marketing",
        "version": "1"
    },
    "jsonrpc": "2.0",
    "id": 1
}

Response:

{
    "result": {
        "success": true
    },
    "id": "1",
    "jsonrpc": "2.0"
}

Remember! you can always check it by yourself using API Console - updateConsentDefinition()

Back to Customer API


We use cookies to ensure that we provide you the best service and website experience. Read our Cookie policy for more details.