Skip to main content
PATCH
/
settings
Update configuration
curl --request PATCH \
  --url https://api.errorgolf.com/v1/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "live_code": "1AB2CD3EF4",
  "email": "newemail@techcorp.com",
  "password": "<string>",
  "password_confirmation": "<string>",
  "webhook_url": "https://api.yourcompany.com/webhooks/error-golf",
  "webhook_secret": "abc123def456ghi789",
  "per_candidate": 2,
  "personality_first": "jaded_dev",
  "personality_second": "caffeinated_genius",
  "personality_third": "mad_scientist"
}'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

JWT token from /token endpoint

Body

application/json
​
live_code
string

New live code (must start with digit and be unique)

Minimum length: 10
Example:

"1AB2CD3EF4"

​
email
string<email>

New email address (must be unique)

Example:

"newemail@techcorp.com"

​
password
string

New password (requires confirmation)

Minimum length: 10
​
password_confirmation
string

Password confirmation (required if password provided)

​
webhook_url
string<uri>

Webhook URL for result notifications (empty string to disable)

Example:

"https://api.yourcompany.com/webhooks/error-golf"

​
webhook_secret
string

Secret for webhook signature verification

Minimum length: 10
Example:

"abc123def456ghi789"

​
per_candidate
integer

Maximum attempts per candidate email

Required range: 1 <= x <= 4
Example:

2

​
personality_first
string

First evaluator personality

Example:

"jaded_dev"

​
personality_second
string

Second evaluator personality

Example:

"caffeinated_genius"

​
personality_third
string

Third evaluator personality

Example:

"mad_scientist"

Response

Settings updated successfully

⌘I