Console API

Business claims

3 endpoints.

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

Who holds this business, and whether the caller can claim or extend

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_ClaimStateData_

Field Type Description

request_idrequired string

success true default true

datarequired

ClaimStateData

ClaimStateData fields

Field Type Description

business_idrequired string

claim

ClaimData | null

ClaimData fields

Field	Type	Description
`business_id`required	`string`
`holder_id`required	`string`
`holder_name`	`string \| null`
`claimed_at`required	`string (date-time)`
`expires_at`required	`string (date-time)`
`extended`required	`boolean`
`mine`required	`boolean`

launchedrequired boolean

can_claimrequired boolean

can_extendrequired boolean

server_timerequired string (date-time)

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.

PUT/api/v1/admin/businesses/{business_id}/claim

Claim a business nobody holds, for 24 hours

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_ClaimStateData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ClaimStateData`	ClaimStateData fields ClaimStateData, 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}/claim/extend

Extend the caller's claim once, by another 24 hours

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_ClaimStateData_

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