Set custom name for subscriber

Set a custom display name for a subscriber

Permission Required: subscribers:write

PUT /v2/access/subscribers/:userId/custom-name

Set custom name for subscriber

cURL

curl --request PUT \
  --url https://api.ofauth.com/v2/access/subscribers/:userId/custom-name \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '
{
  "displayName": "<string>"
}
'

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

Body

application/json

displayName · string · required

Custom display name for subscriber

Required string length: 1 - 100

Response

200

application/json

Successful response

The response is of type object.