memberSettings.updateMemberSettings

PATCH

/v1/me/settings

const url = 'https://example.com/v1/me/settings';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"expectedVersion":1,"planApproval":{"approver":"chain","timeoutMs":1,"onTimeout":"run"},"defaultBot":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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" }, "defaultBot": "example" }'

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

Authorizations

token
session

Request Body^required

application/json

object

expectedVersion

required

integer

<= 9007199254740991

planApproval

Any of:

object
null

object

approver

required

string

Allowed values: chain person

timeoutMs

required

integer

>= 1000 <= 604800000

onTimeout

required

string

Allowed values: run stay

defaultBot

Any of:

string
null

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

version

required

integer

<= 9007199254740991

planApproval

required

Any of:

object
null

object

approver

required

string

Allowed values: chain person

timeoutMs

required

integer

>= 1000 <= 604800000

onTimeout

required

string

Allowed values: run stay

defaultBot

required

Any of:

string
null

string

>= 1 characters <= 128 characters

updatedAt

required

string

Example

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

400

SettingsInvalid | OrganizationRequired

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: SettingsInvalid

message

required

string

Example

{
  "_tag": "SettingsInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

409

SettingsConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: SettingsConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "SettingsConflict"
}

429

RateLimited

application/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

SettingsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: SettingsUnavailable

Example

{
  "_tag": "SettingsUnavailable"
}

memberSettings.updateMemberSettings

Authorizations

Request Bodyrequired

Responses

200

Example

400

Example

401

Example

403

Example

409

Example

429

Example

503

Example

Request Body^required