Skip to main content
PATCH
Update signal settings

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_settings.

false stops coding every link of the team at once; true lets a verified site with link_codes_enabled code again. The send paths follow within five minutes.

profile_views_enabled
boolean

false stops reading every sender profile's "Who viewed your profile" list (a run already queued finishes); true reads them again from the next hourly scan.

profile_views_excluded_sender_profiles
string[]

The sender profiles to keep out of the profile view collection (unibox sender profile sids, ub_sp_...). Replaces the stored list as a set; [] clears it; a sid outside ub_sp_ is a 422.

Maximum array length: 500
Required string length: 18
Pattern: ^ub_sp_

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.