Skip to main content
PATCH
Update workspace 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.

Body

application/json

Request body of update_workspace_profile.

company
object

The company section, replaced whole: a key left out becomes null (or an empty list), so read the profile first and send the section back with the fields changed.

who_buys
object

The who-buys section, replaced whole (the same rule).

offer
object

The offer section, replaced whole (the same rule).

source
enum<string> | null

Stamps every field of the sections given: website, linkedin_company, linkedin_profile for what a read said, person for the person's own words, creator for an inference; default person. A value the person wrote stands against any other source (kept_fields).

Available options:
linkedin_company,
linkedin_profile,
website,
person,
creator
confirm
boolean | null

True marks the profile confirmed (the person said the cards are right); sent alone, it confirms without a write.

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.