Skip to main content
POST
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
Idempotency-Key
string
required

Required idempotency key. Exact retries of the same canonical request replay the original status, body, ETag, Location, and request ID for 24 hours.

Required string length: 1 - 255

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]+)*$

Body

application/json

Company profile. Metadata and custom fields require Work access. Maximum 65536 bytes.

name
string
required
Required string length: 1 - 255
annualRevenueOere
integer | null
Required range: 0 <= x <= 9007199254740991
customFields
object
description
string | null
Maximum string length: 5000
email
string<email> | null
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,}$
employeeCount
integer | null
Required range: 0 <= x <= 10000000
industry
string | null
Maximum string length: 128
lifecycleStage
enum<string> | null
Available options:
LEAD,
PROSPECT,
CUSTOMER,
CHURNED
linkedinUrl
string | null
Maximum string length: 255
Pattern: ^https?:\/\/
metadata
object
phone
string | null
Maximum string length: 32
website
string | null
Maximum string length: 255
Pattern: ^https?:\/\/
organizationNumber
string
Pattern: ^\d{8}$

Response

Company created or resolved

company
object
required