/
2316: Opt-out of preference

2316: Opt-out of preference

Owned by Nick Jensen
Last updated: Jul 09, 2018Version comment

Update entity preference subscription status: Opt-out

Endpoint ID:2316
Method:

PUT

URL:

/preferences/entity/id/{entityID}/preference/{preferenceID}/opt-out

/preferences/entity/ext-key/{ext-key}/{ext-type}/preference/{preferenceID}/opt-out


entityIDRubiq master ID that uniquely identifies the entity

ext-keyExternal key that uniquely identifies the entity

ext-typeType of external key

preferenceIDA GUID string identifier for the preference
Request body:

A JSON object containing a reason property.

{
    "reason": "No longer interested"
}

If the entity has not previously opted in to this preference, a 404 (sub code 404.6) response will be returned instead of the success status 204.

Response body:

None

Status codes:204OK

404

The entity or preference were not found.

The following sub codes may be returned:

404.1 Entity not found

404.2 External entity reference not found

404.4 Preference not found

404.6 Subscription not found

Related content