Skip to main content
PATCH
Update signal preferences

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of update_signal_preferences.

hidden_types
enum<string>[]

The signal types the feed leaves out. Replaces the stored list as a set ([] shows every type); duplicates collapse, stored in the page's order.

A signal type: a ledger type (the type of search_activities) the Signals page lists, the website's first, then LinkedIn's, then email's.

Available options:
website_visited,
website_key_page_visited,
website_form_submitted,
website_event,
linkedin_connection_request_accepted,
linkedin_message_replied,
linkedin_inmail_replied,
linkedin_invitation_received,
linkedin_followed,
linkedin_message_reacted,
linkedin_message_deleted,
linkedin_profile_viewed_us,
linkedin_connection_removed,
linkedin_blocked,
linkedin_post_published,
linkedin_birthday,
linkedin_work_anniversary,
linkedin_job_changed,
email_opened,
email_link_clicked,
email_replied,
email_bounced,
email_unsubscribed,
email_complained
notify_types
enum<string>[]

The signal types the user is told about (the badge and the toast). Replaces the stored list as a set ([] tells nothing): to add or drop one type, read the row and send the whole list.

A signal type: a ledger type (the type of search_activities) the Signals page lists, the website's first, then LinkedIn's, then email's.

Available options:
website_visited,
website_key_page_visited,
website_form_submitted,
website_event,
linkedin_connection_request_accepted,
linkedin_message_replied,
linkedin_inmail_replied,
linkedin_invitation_received,
linkedin_followed,
linkedin_message_reacted,
linkedin_message_deleted,
linkedin_profile_viewed_us,
linkedin_connection_removed,
linkedin_blocked,
linkedin_post_published,
linkedin_birthday,
linkedin_work_anniversary,
linkedin_job_changed,
email_opened,
email_link_clicked,
email_replied,
email_bounced,
email_unsubscribed,
email_complained
sender_profile_scope
enum<string>

all | mine | chosen: whose sender profiles the feed starts on. Moving off chosen keeps sender_profile_sids.

Available options:
all,
mine,
chosen
sender_profile_sids
string[]

The chosen sender profiles (unibox sender profile sids, ub_sp_..., 18 characters), at most 200; duplicates collapse. Read when sender_profile_scope is chosen, where [] means every sender profile.

Maximum array length: 200
Required string length: 18
Pattern: ^ub_sp_
toast_enabled
boolean

false stops the toasts; the badge still counts.

saved_views
object[]

The whole list of saved views, at most 20; replaces the stored one ([] clears it). Send the stored views with their ids to keep them.

Maximum array length: 20

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.