Update the value of a specific preference for a UserUUID

ApiScope: manage.user.write
API Scope Level: ServiceSubscriberScope

Path Parameters

user_uuid string required
preference string required

application/json

Request Body required

keyName string
value string
promptType string
possibleValues string
description string

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

application/x-protobuf

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal Server Error

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

POST /v2/user/:user_uuid/preference/:preference

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

user_uuid — path required

preference — path required

Body required

{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

python / requests

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

go / native

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

nodejs / axios

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

csharp / RestSharp

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

php / cURL

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

java / OkHttp

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'

powershell / RestMethod

curl -L -X POST '/manage/v2/user/:user_uuid/preference/:preference' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "keyName": "string",
  "value": "string",
  "promptType": "string",
  "possibleValues": "string",
  "description": "string"
}'