Skip to main content
POST
Create Portfolio Item

Authorizations

X-API-Key
string
header
required

Body

application/json
business_search_id
string<uuid> | null

The optional UUID of the search that this portfolio item is based on.

Example:

"ede786f3-33ae-4894-843d-af2025f1d5b0"

person_search_id
string<uuid> | null

The optional UUID of the search that this portfolio item is based on.

Example:

"ede786f3-33ae-4894-843d-af2025f1d5b0"

group_id
string<uuid> | null

The optional UUID of the group to add the newly created item to.

Example:

"ede786f3-33ae-4894-843d-af2025f1d5b0"

Response

Successful Response

Represents a business portfolio item

id
string<uuid>
required

The unique identifier of the portfolio item.

Example:

"ede786f3-33ae-4894-843d-af2025f1d5b0"

search_id
string<uuid>
required

The unique identifier of the search that the portfolio item is based on.

Example:

"c623e29e-1f57-11ef-938f-1edb1b067314"

name
string
required

The name of the portfolio item.

created_at
string<date-time>
required

The timestamp of when the portfolio item was created.

type
string
required

The type of the portfolio item.

Allowed value: "Business"
business
BusinessSummaryResponse (v1) · object
required

The business associated with the portfolio item.

group_id
string<uuid> | null

The UUID of the portfolio group that the item belongs to.

user
UserAttributionResponse (v1) · object | null

The user who created the portfolio item.

comments
PortfolioItemCommentResponse (v1) · object[]
attachments
AttachmentResponseModel (v1) · object[]
scores
ScoreResponse (v1) · object[]
last_monitored_at
string<date-time> | null

The timestamp of when the portfolio item was last monitored.