Skip to main content
PATCH
Update sender profile

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.

Path Parameters

sid
string
required

Sender profile sid (ub_sp_…).

Required string length: 18
Pattern: ^ub_sp_

Body

application/json

Request body of update_sender_profile.

name
string

New display persona name (1..255); connecting an account never renames the profile.

Required string length: 1 - 255
label
string | null

null or an empty string clears the label.

Maximum string length: 255
avatar_url
string | null

Display photo URL; on a sender profile with a LinkedIn account, the account's photo takes its place again at the next read.

Maximum string length: 2048
assignee_user_sid
string | null

null unassigns the operator.

Required string length: 18
linkedin_history_since
string | null

The LinkedIn history window; present with null = all history, now = only what arrives from this change on. An earlier day, or null, re-walks the account down to it (history_sync pending); a later day, or now, deletes nothing, only bounds later runs.

Pattern: ^(now|\d{4}-\d{2}-\d{2})$
linkedin_history_scope
enum<string> | null

The LinkedIn import scope; present with null = playtable_people, the default. Back to all re-walks the account (history_sync pending) so the conversations the people-only scope kept out come in; playtable_people deletes nothing and narrows later runs.

Available options:
all,
playtable_people

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.