Skip to content
Prokure Docs

Update notification settings

PATCH
/api/v1/settings/notifications
curl --request PATCH \
  --url https://app.prokure.ca/api/v1/settings/notifications \
  --header 'Content-Type: application/json' \
  --data '{ "digest_days": [ 1 ], "digest_hour": 1, "digest_tz": "example", "digest_min_score": 1, "digest_max_items": 1, "notification_emails": [ "hello@example.com" ], "amendment_notification_policy": "all" }'

Request Bodyrequired

Section titled “Request Bodyrequired”

Any non-empty subset of the writable notification settings; unknown fields are rejected.

Media typeapplication/json

Any non-empty subset of the writable notification settings; unknown fields are rejected.

object
digest_days

ISO weekdays 1 (Monday) to 7 (Sunday), unique, sorted ascending on write. An empty list pauses the digest.

Array<integer>
<= 7 items
digest_hour
integer
<= 23
digest_tz

IANA time zone name, e.g. America/Vancouver

string
>= 1 characters <= 64 characters
digest_min_score
integer
<= 100
digest_max_items
integer
>= 3 <= 15
notification_emails

Recipient addresses; trimmed, lower-cased and de-duplicated before the cap of 10 distinct addresses is applied. An empty list falls back to the account contact email.

Array<string>
<= 200 items
amendment_notification_policy
string
Allowed values: all positive_only none

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
digest_days
required
Array<integer>
digest_hour
required
integer
>= -9007199254740991 <= 9007199254740991
digest_tz
required
string
digest_min_score
required
integer
>= -9007199254740991 <= 9007199254740991
digest_max_items
required
integer
>= -9007199254740991 <= 9007199254740991
notification_emails
required
Array<string>
amendment_notification_policy
required
string
Allowed values: all positive_only none
effective_recipients
required
Array<string>
last_digest_sent_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
next_digest_at
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
Example
{
  "amendment_notification_policy": "all"
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}