Skip to content

Update Desk Linkedin Sender

PUT
/desk/linkedin-sender

Claim a LinkedIn account for this rep, or release the claim with null.

The claim is EXCLUSIVE and enforced by unique constraints, not by a permission: claiming an account a colleague holds is a 409. Sending null gives the claim up, which is the only way to hand an account over.

No admin gate, deliberately, and the app says why: this is a per-user identity rather than an org decision, and an admin permission here would stop reps doing the one thing they were told to do.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Claim a LinkedIn account for this rep, or give the claim up.

NULL is the release, not a no-op. The claim is exclusive: two unique constraints on the underlying table are what stop a rep taking a colleague’s account, so a claim on a held account is refused with a 409 rather than silently reassigned.

object
provider_member_id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string