cURL
curl --request PATCH \
--url 'https://app.floral.so/api/v1/workspaces/acme-nordic/companies/42' \
--header 'Authorization: Bearer $FLORAL_TOKEN' \
--header 'If-Match: "v1.Y29tcGFueS00Mi0y"' \
--header 'Content-Type: application/json' \
--data '{
"lifecycleStage": "CUSTOMER",
"metadata": {
"source": "partner-directory",
"tier": "customer"
},
"phone": "+45 33 12 34 56"
}'const options = {
method: 'PATCH',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
lifecycleStage: 'CUSTOMER',
metadata: {source: 'partner-directory', tier: 'customer'},
phone: '+45 33 12 34 56'
})
};
fetch('https://app.floral.so/api/v1/workspaces/{workspaceSlug}/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"company": {
"annualRevenueOere": 12500000,
"archivedAt": null,
"customFields": {
"account_tier": "growth"
},
"description": "Nordic workplace design and furniture supplier.",
"email": "hello@acme-nordic.example",
"employeeCount": 48,
"id": 42,
"industry": "Design",
"lastActivityAt": "2026-08-15T09:30:00.000Z",
"lifecycleStage": "CUSTOMER",
"linkedinUrl": "https://www.linkedin.com/company/acme-nordic",
"metadata": {
"source": "partner-directory",
"tier": "customer"
},
"name": "Acme Nordic",
"organizationNumber": "12345678",
"ownerUserIds": [
"user_01J5N9CF9QY8T4M2A7W3R6K1P0"
],
"people": [
{
"email": "ada@acme-nordic.example",
"id": 84,
"name": "Ada Jensen",
"title": "Operations director"
}
],
"phone": "+45 33 12 34 56",
"updatedAt": "2026-08-15T09:30:00.000Z",
"version": "v1.Y29tcGFueS00Mi0y",
"website": "https://acme-nordic.example"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "The request contains invalid values.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "A valid bearer credential is required.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The credential does not grant this operation.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The resource was not found.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with the current resource state.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "VERSION_CONFLICT",
"message": "The resource changed since it was read.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "PRECONDITION_REQUIRED",
"message": "If-Match is required for this operation.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry shortly.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Companies
Update a company
Apply a partial profile update and typed custom-field merge patch. Lifecycle, metadata, and custom fields require Work access.
PATCH
https://app.floral.so
/
api
/
v1
/
workspaces
/
{workspaceSlug}
/
companies
/
{id}
cURL
curl --request PATCH \
--url 'https://app.floral.so/api/v1/workspaces/acme-nordic/companies/42' \
--header 'Authorization: Bearer $FLORAL_TOKEN' \
--header 'If-Match: "v1.Y29tcGFueS00Mi0y"' \
--header 'Content-Type: application/json' \
--data '{
"lifecycleStage": "CUSTOMER",
"metadata": {
"source": "partner-directory",
"tier": "customer"
},
"phone": "+45 33 12 34 56"
}'const options = {
method: 'PATCH',
headers: {
'If-Match': '<if-match>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
lifecycleStage: 'CUSTOMER',
metadata: {source: 'partner-directory', tier: 'customer'},
phone: '+45 33 12 34 56'
})
};
fetch('https://app.floral.so/api/v1/workspaces/{workspaceSlug}/companies/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"company": {
"annualRevenueOere": 12500000,
"archivedAt": null,
"customFields": {
"account_tier": "growth"
},
"description": "Nordic workplace design and furniture supplier.",
"email": "hello@acme-nordic.example",
"employeeCount": 48,
"id": 42,
"industry": "Design",
"lastActivityAt": "2026-08-15T09:30:00.000Z",
"lifecycleStage": "CUSTOMER",
"linkedinUrl": "https://www.linkedin.com/company/acme-nordic",
"metadata": {
"source": "partner-directory",
"tier": "customer"
},
"name": "Acme Nordic",
"organizationNumber": "12345678",
"ownerUserIds": [
"user_01J5N9CF9QY8T4M2A7W3R6K1P0"
],
"people": [
{
"email": "ada@acme-nordic.example",
"id": 84,
"name": "Ada Jensen",
"title": "Operations director"
}
],
"phone": "+45 33 12 34 56",
"updatedAt": "2026-08-15T09:30:00.000Z",
"version": "v1.Y29tcGFueS00Mi0y",
"website": "https://acme-nordic.example"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "The request contains invalid values.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "A valid bearer credential is required.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "The credential does not grant this operation.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "The resource was not found.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "The requested change conflicts with the current resource state.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "VERSION_CONFLICT",
"message": "The resource changed since it was read.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "PRECONDITION_REQUIRED",
"message": "If-Match is required for this operation.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Too many requests. Retry shortly.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred.",
"requestId": "550e8400-e29b-41d4-a716-446655440000"
}
}Authorizations
Authenticate with a workspace-pinned Floral personal access token.
Headers
Optional caller-generated correlation ID. Floral returns the effective value in X-Request-ID.
Required string length:
1 - 128Strong ETag from the latest detail or mutation response. A stale value returns 412 VERSION_CONFLICT.
Pattern:
^"(?:[^"\\]|\\.)*"$Path Parameters
Slug of the workspace pinned to the credential.
Required string length:
1 - 100Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Stable numeric resource ID.
Required range:
x >= 1Body
application/json
Fields omitted from the patch remain unchanged. Explicit null clears a nullable field. Lifecycle, metadata, and custom fields require Work access. Maximum 65536 bytes.
Required range:
0 <= x <= 9007199254740991Show child attributes
Show child attributes
Maximum string length:
5000Maximum string length:
320Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Required range:
0 <= x <= 10000000Maximum string length:
128Available options:
LEAD, PROSPECT, CUSTOMER, CHURNED Maximum string length:
255Pattern:
^https?:\/\/Show child attributes
Show child attributes
Required string length:
1 - 255Maximum string length:
32Maximum string length:
255Pattern:
^https?:\/\/Response
Company updated
Show child attributes
Show child attributes
