sender_profiles

Update sender profile

Partial edit of a sender profile's config: name, label, avatar_url, assignee_user_sid, linkedin_history_since and linkedin_history_scope (the LinkedIn channel's history window and import scope; an earlier day or a wider scope re-walks the account). Account refs are refused here (the channel verbs own them), and so is the channel state (linkedin_status, a mailbox status): a broken channel is fixed on the account. A sender profile cannot be paused: it has no status.

Contract:

  • MCP tool update_sender_profile, registry package mcp.unibox/sender_profiles, mount unibox.sender-profiles.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/sender-profiles/{sid}

Request

  • Base URL
    https://beta.getsales.io/unibox/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Sender profile sid (ub_sp_…).

Request body

namestring

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

labelstring nullable

null or an empty string clears the label.

avatar_urlstring nullable

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

assignee_user_sidstring nullable

null unassigns the operator.

linkedin_history_sincestring nullable

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.

linkedin_history_scope'all' | 'playtable_people' nullable

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.

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

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

Changes

No recorded changes to this operation across all 1 revision of this API.