Update Actor Settings

PUT /settings

Updates notification preferences for the bearer-authenticated actor and returns the current settings view.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://api.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The API follows OpenAPI Specification 3.x. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://api.allsign.app/settings" \
  -X PUT \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  --data-raw '{}'

Request

Request Body

{
  "agreement_execution": true,
  "agreement_invitations": true,
  "comments_mentions": true,
  "signature_requests": true,
  "term_revisions": true,
  "weekly_digest": true
}

agreement_execution

booleanoptional

agreement_invitations

booleanoptional

comments_mentions

booleanoptional

signature_requests

booleanoptional

term_revisions

booleanoptional

weekly_digest

booleanoptional

Responses

200 OK

Updated actor settings.

{
  "data": {
    "settings": {
      "notifications": {
        "agreement_execution": true,
        "agreement_invitations": true,
        "comments_mentions": true,
        "signature_requests": true,
        "term_revisions": true,
        "weekly_digest": true
      },
      "security": {}
    }
  }
}

data

objectrequired

data.settings

Settings view for the authenticated actor.

objectrequired

data.settings.notifications

Notification preference flags for the authenticated actor.

objectrequired

data.settings.notifications.agreement_execution

booleanrequired

data.settings.notifications.agreement_invitations

booleanrequired

data.settings.notifications.comments_mentions

booleanrequired

data.settings.notifications.signature_requests

booleanrequired

data.settings.notifications.term_revisions

booleanrequired

data.settings.notifications.weekly_digest

booleanrequired

data.settings.security

Security context for the authenticated actor.

objectrequired

400 Bad Request

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

401 Unauthorized

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

422 Unprocessable Entity

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional