Skip to main content
PATCH
Update a person

Authorizations

Authorization
string
header
required

An API key issued by a company administrator — an environment prefix (production: sdb_live_) followed by 32 characters. The prefix identifies the environment and MUST NOT be hard-coded or validated by clients; treat the whole key as opaque. Shown exactly once at creation; only a one-way hash is stored.

Scopes (granted per key on the create screen; :write never implies :read):

  • skills:read
  • skills:write
  • people:read
  • people:write
  • careers:read
  • careers:write
  • training:read
  • training:write
  • flags:read
  • flags:write
  • org:read
  • org:write
  • assessments:read
  • learning:read
  • learning:write
  • certifications:read
  • certifications:write
  • assessments:write
  • proficiency:read
  • proficiency:write
  • surveys:read
  • surveys:write
  • labels:read
  • labels:write

Headers

Idempotency-Key
string

Any unique string (at most 200 characters). Retrying with the same key and identical content replays the stored response for 24h instead of executing twice.

Maximum string length: 200

Path Parameters

id
string
required

The person's email address — or the opaque person id from any response.

Example:

"ada@example.com"

Body

application/json
firstName
string
Maximum string length: 50
Example:

"Dana"

lastName
string
Maximum string length: 50
Example:

"Reviewer"

externalId
string | null
Maximum string length: 20
Example:

"EMP-0042"

businessPhone
string | null
mobilePhone
string | null
homePhone
string | null
address
string | null
city
string | null
stateProvince
string | null
postalCode
string | null
countryId
string | null
webPage
string | null
externalCompanyName
string | null
nextAvailableDate
string | null

Response

The resource, enveloped.

data
object
required