Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Update a preference
Updates a preference.
Updates a preference.
- Path
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference - Scope
notify:write - Effect
write— a successful call changes state. - Collection preferences
- Query
update_mask,allow_missing,validate_only
#Request
| Field | Type | What it is |
|---|---|---|
preference | Preference | The preference to update; name identifies it. Required. |
update_mask | field_mask | The fields to write; unset writes every populated field. |
allow_missing | bool | Create the preference when it does not exist (declarative upsert). |
validate_only | bool | Validate and return the result without writing anything. |
#Preference
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/preferences/{preference}. |
meta | ResourceMeta | Resource metadata. |
channels | Channel[] | Channels the topic may use; empty mutes the topic. One of email, sms, push, inbox. |
digest_interval | duration | Batch this topic into a digest at most this often; unset sends each message. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/recipients/{recipient}/preferences/{preference}. |
uid | string | prf_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
channels | Channel[] | Channels the topic may use; empty mutes the topic. One of email, sms, push, inbox. |
digest_interval | duration | Batch this topic into a digest at most this often; unset sends each message. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/projects/shop/envs/production/recipients/recipient/preferences/preference"}'