Console API

Offers

5 endpoints.

PUT/api/v1/admin/businesses/{business_id}/offers/{offer_id}

Update an offer

Update an offer's fields. 404 if not found.

Parameters

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

Request bodyrequired

application/jsonOfferUpdateBody

Field	Type	Description
`offer_name`	`string \| null`
`offer_description`	`string \| null`
`value_terms`	`string \| null`
`expires_at`	`integer \| null`
`sort_order`	`integer \| null`
`active`	`boolean \| null`

Responses

200Successful Response

application/jsonSuccessResponse_OfferData_

Field Type Description

request_idrequired string

success true default true

datarequired

OfferData

OfferData fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`offer_name`required	`string`
`offer_description`	`string \| null`
`value_terms`	`string \| null`
`expires_at`	`integer \| null`
`sort_order`	`integer`	default 0
`active`	`boolean`	default true
`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/{package_id}/offers

Attach a new offer to a package

Create an offer and link it to the package. 404 if package 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/jsonOfferCreateBody

Field	Type	Description
`offer_name`required	`string`
`offer_description`	`string \| null`
`value_terms`	`string \| null`
`expires_at`	`integer \| null`
`sort_order`	`integer`	default 0
`active`	`boolean`	default true

Responses

201Successful Response

application/jsonSuccessResponse_OfferData_

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

Detach an offer from a package

Unlink an offer from a package (and reap it if now orphaned). 404 if not linked.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`package_id`required	path	`string (uuid)`
`offer_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.

POST/api/v1/admin/businesses/{business_id}/service-items/{service_item_id}/offers

Attach a new offer to a service item

Create an offer and link it to the service item. 404 if service item not found.

Parameters

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

Request bodyrequired

application/jsonOfferCreateBody

OfferCreateBody, expanded above.

Responses

201Successful Response

application/jsonSuccessResponse_OfferData_

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

Detach an offer from a service item

Unlink an offer from a service item (and reap it if now orphaned). 404 if not linked.

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`service_item_id`required	path	`string (uuid)`
`offer_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.