/
2310: Get preference opt-in status
2310: Get preference opt-in status
Fetch entity preference subscription details for all preferences
Endpoint ID: | 2310 | |
Method: | GET | |
URL: | /preferences/entity/id/{entityID} /preferences/entity/ext-key/{ext-key}/{ext-type} | |
entityID | Rubiq master ID that uniquely identifies the entity | |
ext-key | External key that uniquely identifies the entity | |
ext-type | Type of external key | |
Request body: | None | |
Response body: | JSON data containing an array of all preferences, with the The entity has opted in to a single preference { "entityPreferences": [ { "preferenceID": "7a6776a3-9411-4d34-9866-99aa9ac7cc27", "optedIn": false }, { "preferenceID": "dd9eaf78-18ff-44ea-9717-25b103060643", "optedIn": true } ] } | |
Status codes: | 200 | OK |
404 | The entity was not found The following sub codes may be returned:
|
, multiple selections available,
Related content
2311: Get individual preference opt-in status
2311: Get individual preference opt-in status
More like this
2318: Update specific entity preferences
2318: Update specific entity preferences
More like this
2315: Opt-in to preference
2315: Opt-in to preference
More like this
2316: Opt-out of preference
2316: Opt-out of preference
More like this
2300: Get preferences
2300: Get preferences
More like this
2317: Update entity preferences for group
2317: Update entity preferences for group
More like this