Skip to content
OpenBot

memberSettings.updateMemberSettings

PATCH
/v1/me/settings
curl --request PATCH \
  --url https://example.com/v1/me/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectedVersion": 1, "planApproval": { "approver": "chain", "timeoutMs": 1, "onTimeout": "run" } }'

Changes your settings. Send the version that you read as expectedVersion. If they changed since then, the change fails with SettingsConflict.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
expectedVersion
required
integer
<= 9007199254740991
planApproval
Any of:
object
approver
required
string
Allowed values: chain person
timeoutMs
required
integer
>= 1000 <= 604800000
onTimeout
required
string
Allowed values: run stay

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
version
required
integer
<= 9007199254740991
planApproval
required
Any of:
object
approver
required
string
Allowed values: chain person
timeoutMs
required
integer
>= 1000 <= 604800000
onTimeout
required
string
Allowed values: run stay
updatedAt
required
string

Example 

{
  "planApproval": {
    "approver": "chain",
    "onTimeout": "run"
  }
}

400

Section titled “400”

SettingsInvalid | OrganizationRequired

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsInvalid
message
required
string

Example 

{
  "_tag": "SettingsInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

PermissionDenied | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PermissionDenied
permission
required
string
Allowed values: responses.run sessions.read sessions.write requests.resolve agents.read agents.write agents.delegate triggers.read triggers.write channels.read channels.write channels.use channel_identities.read channel_identities.write connections.read connections.write apps.use apps.publish models.use tokens.read tokens.write organization.read organization.write roles.write model_providers.read model_providers.write sso.read sso.write platform.read platform.write members.read members.write audit_logs.read usage.read budgets.read budgets.write
resource
required
string

Example 

{
  "_tag": "PermissionDenied",
  "permission": "responses.run"
}

409

Section titled “409”

SettingsConflict

Media typeapplication/json
object
_tag
required
string
Allowed values: SettingsConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "SettingsConflict"
}

429

Section titled “429”

RateLimited

Media typeapplication/json
object
_tag
required
string
Allowed values: RateLimited
retryAfterSeconds
required
integer
>= -9007199254740991 <= 9007199254740991

Example 

{
  "_tag": "RateLimited"
}

503

Section titled “503”

SettingsUnavailable | AuthorizationUnavailable | AuthenticationUnavailable

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsUnavailable

Example 

{
  "_tag": "SettingsUnavailable"
}