Skip to content

Approve Company Profile

POST
/company-profile/approve

Approve the profile. It becomes the org’s source of truth and is locked.

Refused until the first generation run has completed. Undo with POST /company-profile/unapprove.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Names the company profile to act on, by the website it was built from.

Mirrors campaign_builder.routers.company_profile.ApproveProfileRequest, which is the same single field. The reindex route reads the same value as a QUERY parameter on a POST in the app; it is a body here because a POST that carries its only input in the URL is the kind of asymmetry a client library gets wrong once and then works around forever.

object
website_url
required

Website the profile was built from. Matched on its canonical domain.

string

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

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