Agent API

FAQ

6 endpoints.

GET/api/v1/agent/businesses/{business_id}/faqs

List FAQs (agent)

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_list_FaqData__

Field Type Description

request_idrequired string

success true default true

datarequired

FaqData[]

FaqData[] fields

Field	Type	Description
`id`required	`string`
`business_id`required	`string`
`question`required	`string`
`answer`required	`string`
`photos`	`PhotoData[]`	PhotoData[] fields Nested object (not expanded)
`display_order`	`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/agent/businesses/{business_id}/faqs

Create FAQ (agent)

Parameters

Name	In	Type	Description
`business_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonFaqCreateBody

Field	Type	Description
`question`required	`string`
`answer`required	`string`
`photo_ids`	`string[]`	max items 5 string[] fields

Responses

201Successful Response

application/jsonSuccessResponse_FaqData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FaqData`	FaqData fields FaqData, 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/agent/businesses/{business_id}/faqs/{faq_id}

Get FAQ (agent)

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`faq_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_FaqData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FaqData`	FaqData fields FaqData, 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/agent/businesses/{business_id}/faqs/{faq_id}

Update FAQ (agent)

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`faq_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonFaqUpdateBody

Field	Type	Description
`question`	`string \| null`
`answer`	`string \| null`
`photo_ids`	`string[] \| null`	string[] \| null fields

Responses

200Successful Response

application/jsonSuccessResponse_FaqData_

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

PATCH/api/v1/agent/businesses/{business_id}/faqs/{faq_id}

Partial update FAQ (agent)

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`faq_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Request bodyrequired

application/jsonFaqUpdateBody

FaqUpdateBody, expanded above.

Responses

200Successful Response

application/jsonSuccessResponse_FaqData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`FaqData`	FaqData fields FaqData, 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/agent/businesses/{business_id}/faqs/{faq_id}

Delete FAQ (agent)

Parameters

Name	In	Type
`business_id`required	path	`string (uuid)`
`faq_id`required	path	`string (uuid)`
`x-internal-api-key`	header	`string \| null`

Responses

204Successful Response

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

Error bodies: ErrorResponse. See Errors.