Skip to main content
PATCH
Update a sender profile

Authorizations

X-API-Key
string
header
required

Path Parameters

profile_id
string<uuid>
required

Body

application/json

A field omitted from the request is left unchanged.

first_name
string
Maximum string length: 128
last_name
string
Maximum string length: 128
name
string
Required string length: 1 - 255
signature_text

Plain-text signature appended to every send.

Response

Successful Response

created_at
string<date-time>
required
id
string<uuid>
required
mailbox_count
integer
required
name
string
required
status
enum<string>
required

Lifecycle of a sender profile.

A profile is DRAFT from the moment it is created and becomes ACTIVE once at least one mailbox is attached. The status is derived from attachment, never stored — it cannot drift.

Available options:
draft,
active
updated_at
string<date-time>
required
daily_limit
integer
default:0
first_name
string
default:""
last_name
string
default:""
linkedin_daily_cap
integer
default:0
linkedin_identity
string | null
linkedin_invites_today
integer
default:0
linkedin_messages_today
integer
default:0
linkedin_presence
enum<string> | null

How recently ANY browser connected to this sender checked in.

Three states, not two, because two different questions are asked of a connection. ACTIVE answers "can a step run right now" — a browser is open and heartbeating. IDLE answers "is this still set up" — the laptop was closed for the evening. NOT_SEEN is the one that needs a person: nothing has checked in for a day, and queued work is silently waiting.

Available options:
active,
idle,
not_seen
linkedin_today
integer
default:0
sent_today
integer
default:0
signature_text
string
default:""