Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

Authenticate with a workspace-pinned Floral personal access token.

Headers

X-Request-ID
string

Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.

Required string length: 1 - 128
If-Match
string
required

Strong ETag from the latest detail or mutation response. A stale value returns 412 VERSION_CONFLICT.

Pattern: ^"(?:[^"\\]|\\.)*"$

Path Parameters

workspaceSlug
string
required

Slug of the workspace pinned to the credential.

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
id
integer
required

Stable numeric resource ID.

Required range: x >= 1

Body

application/json

Omitted fields remain unchanged. A null companyId detaches the current company; metadata replaces the full map; customFields is a typed merge patch. Maximum 65536 bytes.

companyId
integer | null
Required range: 0 < x <= 2147483647
customFields
object
department
string | null
Required string length: 1 - 128
description
string | null
Required string length: 1 - 5000
email
string<email>
Maximum string length: 320
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
lifecycleStage
enum<string> | null
Available options:
LEAD,
PROSPECT,
CUSTOMER,
CHURNED
linkedinUrl
string<uri> | null
Maximum string length: 255
metadata
object
mobile
string | null
Required string length: 1 - 32
name
string
Required string length: 1 - 255
phone
string | null
Required string length: 1 - 32
title
string | null
Required string length: 1 - 128

Response

Person updated

person
object
required