Console API

Packages

9 endpoints.

GET/api/v1/admin/businesses/{business_id}/packages

Get all packages

Get all packages for a business (ordered by display_order). Member service items not included.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_list_PackageData__

Field Type Description

request_idrequired string

success true default true

datarequired

PackageData[]

PackageData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`package_name`required	`string`
`package_description`required	`string`
`package_summary`	`string \| null`
`pricing_info`	`string \| null`
`features`	`string \| null`
`cost`	`string \| null`
`slug`required	`string`
`photos`	`PhotoData[]`	PhotoData[] fields Nested object (not expanded)
`service_items`	`ServiceItemSummaryData[]`	ServiceItemSummaryData[] fields Nested object (not expanded)
`offers`	`OfferData[]`	OfferData[] fields Nested object (not expanded)
`display_order`	`integer`	default 0
`is_featured`	`boolean \| null`
`created_at`	`integer`	default 0
`updated_at`	`integer`	default 0

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.

POST/api/v1/admin/businesses/{business_id}/packages

Create package

Create a new package.

Parameters

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

Request bodyrequired

application/jsonPackageCreateBody

Field	Type	Description
`package_name`required	`string`
`package_description`required	`string`
`package_summary`	`string \| null`
`pricing_info`	`string \| null`
`features`	`string \| null`
`cost`	`number \| string \| null`	number \| string \| null fields number string
`slug`	`string \| null`
`photo_ids`	`string[]`	max items 5 string[] fields
`is_featured`	`boolean \| null`

Responses

201Successful Response

application/jsonSuccessResponse_PackageData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PackageData`	PackageData fields PackageData, 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}/packages/{package_id}

Get package details

Get package by id with member service items. 404 if not found.

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_PackageData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PackageData`	PackageData fields PackageData, 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.

PUT/api/v1/admin/businesses/{business_id}/packages/{package_id}

Update package

Update package details. 404 if not found.

Parameters

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

Request bodyrequired

application/jsonPackageUpdateBody

Field	Type	Description
`package_name`	`string \| null`
`package_description`	`string \| null`
`package_summary`	`string \| null`
`pricing_info`	`string \| null`
`features`	`string \| null`
`cost`	`number \| string \| null`	number \| string \| null fields number string
`slug`	`string \| null`
`photo_ids`	`string[] \| null`	string[] \| null fields
`is_featured`	`boolean \| null`

Responses

200Successful Response

application/jsonSuccessResponse_PackageData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PackageData`	PackageData fields PackageData, 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.

DELETE/api/v1/admin/businesses/{business_id}/packages/{package_id}

Delete package

Delete a package. Member service items survive (join rows cascade). 404 if not found.

Parameters

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

Responses

204Successful Response

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

Error bodies: ErrorResponse. See Errors.

PUT/api/v1/admin/businesses/{business_id}/packages/{package_id}/service-items

Set package member service items

Replace the package's member service items (and their in-package order). 404 if not found.

Parameters

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

Request bodyrequired

application/jsonPackageServiceItemsBody

Field	Type	Description
`ordered_service_item_ids`required	`string[]`	string[] fields

Responses

200Successful Response

application/jsonSuccessResponse_PackageData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PackageData`	PackageData fields PackageData, 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}/packages/{package_id}/service-items/{service_item_id}

Add service item to package

Add a service item to a package (appended last). 404 if package not found.

Parameters

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

Responses

204Successful Response

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

Error bodies: ErrorResponse. See Errors.

DELETE/api/v1/admin/businesses/{business_id}/packages/{package_id}/service-items/{service_item_id}

Remove service item from package

Remove a service item from a package. 404 if package or membership not found.

Parameters

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

Responses

204Successful Response

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

Error bodies: ErrorResponse. See Errors.

PUT/api/v1/admin/businesses/{business_id}/packages/reorder

Reorder packages

Reorder packages by ordered list of package ids.

Parameters

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

Request bodyrequired

application/jsonPackageReorderBody

Field	Type	Description
`ordered_package_ids`required	`string[]`	string[] fields

Responses

200Successful Response

application/jsonSuccessResponse_list_PackageData__

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`PackageData[]`	PackageData[] fields PackageData, 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.