Skip to content
SurveyRock Support

Update rating settings

PUT
/rating/{id}/settings
curl --request PUT \
  --url https://app.surveyrock.com/api/v1/rating/example/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "settings": { "typeSettings": { "labelsCount": 1, "labels": [ "example" ], "iconType": "example" }, "responseValidation": { "required": true } } }'

Update rating element settings with validation

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 16 characters <= 16 characters

Rating element ID

Request Bodyrequired

Section titled “Request Bodyrequired”

Rating settings update data

Media typeapplication/json
object
settings
required

Rating configuration settings

object
typeSettings
object
labelsCount
integer
>= 2 <= 10
labels
Array<string>
iconType
string
responseValidation
object
required
boolean
Examplegenerated
{
  "settings": {
    "typeSettings": {
      "labelsCount": 1,
      "labels": [
        "example"
      ],
      "iconType": "example"
    },
    "responseValidation": {
      "required": true
    }
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

Settings updated successfully

Media typeapplication/json
object
success
boolean
data
object
elementId
string
updatedAt
string format: date-time
settings
object
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": true,
  "meta": {
    "version": "3.0"
  }
}

422

Section titled “422”

Validation failed

Media typeapplication/json

Validation error response with field-specific errors

object
success
boolean
error
object
code
string
message
string
suggestion
string
retryable
boolean
details

Field-specific validation errors

object
key
additional properties
Array<string>
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": false,
  "error": {
    "code": "validation_failed",
    "message": "Validation failed",
    "suggestion": "Fix the fields listed in details and re-submit.",
    "retryable": false
  },
  "meta": {
    "version": "3.0"
  }
}