Clear subscriber note

Clear the note/notice for a subscriber. Upstream OF clears notes by setting notice to an empty string.

Permission Required: subscribers:write

DELETE /v2/access/subscribers/:userId/note

Clear subscriber note

cURL

curl --request DELETE \
  --url https://api.ofauth.com/v2/access/subscribers/:userId/note \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'

200

{}

Authorizations

apiKey · string · header · required

Your OFAuth API key for authenticating requests.

x-connection-id · string · header · required

Requires a connection via the x-connection-id header.

Path Parameters

userId · string | null

User ID (numeric or username)

Minimum string length: 1

Response

200

application/json

Successful response

The response is of type object.