Console API

Contexts

6 endpoints.

PUT/api/v1/admin/businesses/{business_id}/contexts/{context_type}

Save business context as new version

Persist a new immutable version for the selected context type.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`context_type`required	path	`"business"`
`authorization`	header	`string \| null`

Request bodyrequired

application/jsonBusinessContextUpdateBody

Field	Type	Description
`content`required	`string`
`source_kind`	`enum \| null`
`source_industry_id`	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessContextCurrentData_

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessContextCurrentData

BusinessContextCurrentData fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`context_type`required	`"business"`
`version_number`required	`integer`
`content`required	`string`
`source_kind`required	`enum`	one of "manual", "generated", "restored"
`source_industry_id`	`string \| null`
`restored_from_version_id`	`string \| null`
`created_at`required	`integer`
`updated_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/contexts/{context_type}/current

Get current business context

Get the latest saved context for the selected business and context type.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`context_type`required	path	`"business"`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessContextCurrentData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`BusinessContextCurrentData`	BusinessContextCurrentData fields BusinessContextCurrentData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/contexts/{context_type}/versions

List business context versions

List context versions for the selected business and context type.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`context_type`required	path	`"business"`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_BusinessContextVersionSummaryData__

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessContextVersionSummaryData[]

BusinessContextVersionSummaryData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`context_type`required	`"business"`
`version_number`required	`integer`
`source_kind`required	`enum`	one of "manual", "generated", "restored"
`source_industry_id`	`string \| null`
`restored_from_version_id`	`string \| null`
`created_at`required	`integer`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/admin/businesses/{business_id}/contexts/{context_type}/versions/{version_id}

Get business context version detail

Get the saved content for a historical version.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`context_type`required	path	`"business"`
`version_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessContextVersionData_

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessContextVersionData

BusinessContextVersionData fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`context_type`required	`"business"`
`version_number`required	`integer`
`source_kind`required	`enum`	one of "manual", "generated", "restored"
`source_industry_id`	`string \| null`
`restored_from_version_id`	`string \| null`
`created_at`required	`integer`
`content`required	`string`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/contexts/{context_type}/versions/{version_id}/restore

Restore business context version

Restore a historical version by copying it into a new current version.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`context_type`required	path	`"business"`
`version_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessContextCurrentData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`BusinessContextCurrentData`	BusinessContextCurrentData fields BusinessContextCurrentData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/admin/businesses/{business_id}/contexts/business/generate-outline

Generate business context outline

Generate a Business Context draft from current live SOR business data.

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_BusinessContextGenerateOutlineData_

Field Type Description

request_idrequired string

success true default true

datarequired

BusinessContextGenerateOutlineData

BusinessContextGenerateOutlineData fields

Field	Type	Description
`context_type`	`"business"`	default "business"
`content`required	`string`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.