For the complete documentation index, see llms.txt. This page is also available as Markdown.

Projects

List Projects

get

Retrieve customer business projects managed by the authenticated agency.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get/projects
200

Success

Create Project

post

Provision a new customer business in the agency reseller space.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Object containing response data for this resource.

namestringRequired

Display name for this resource.

Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post/projects
200

Success

Delete Project

delete

Remove a customer project when a client is offboarded.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired

Unique numeric identifier for the project.

Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

delete/projects/{project_id}
200

Success

Duplicate Project

post

Copy an existing project configuration into a new customer business.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired

Unique numeric identifier for the project.

Body

Object containing response data for this resource.

namestringRequired

Display name for this resource.

Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post/projects/{project_id}/duplicate
200

Success

Update Project Overrides

put

Adjust feature limits and flags for a specific customer project.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired

Unique numeric identifier for the project.

Body

Object containing response data for this resource.

customersintegerOptional

Maximum or current allowance for customer records.

locationsintegerOptional

Maximum or current allowance for location records.

membersintegerOptional

Maximum or current allowance for member records.

linksintegerOptional

Maximum or current allowance for link records.

tagsintegerOptional

Maximum or current allowance for tag records.

widgetsintegerOptional

Maximum or current allowance for widget records.

daily_email_requestsintegerOptional

Daily email request limit override.

monthly_email_requestsintegerOptional

Monthly email request limit override.

daily_sms_requestsintegerOptional

Daily SMS request limit override.

monthly_sms_requestsintegerOptional

Monthly SMS request limit override.

forms_advancedbooleanOptional

Whether advanced forms are enabled.

apibooleanOptional

Whether API access is enabled.

webhooksbooleanOptional

Whether webhook access is enabled.

ambassadorbooleanOptional

Whether ambassador features are enabled.

Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

put/projects/{project_id}/overrides
200

Success

Suspend Project

put

Temporarily block a project from operating without deleting its data.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired

Unique numeric identifier for the project.

Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

put/projects/{project_id}/suspend
200

Success

Unsuspend Project

put

Restore access for a previously suspended customer project.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired

Unique numeric identifier for the project.

Responses
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

put/projects/{project_id}/unsuspend
200

Success

Last updated