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

GET /agency/projects HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": [
    {
      "id": 42,
      "name": "Acme Dental",
      "slug": "acme-dental",
      "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
      "is_active": true,
      "is_paused": false,
      "is_suspended": false,
      "features": {
        "asks": 500,
        "customers": 10000,
        "locations": 10,
        "members": 25,
        "links": 10,
        "tags": 50,
        "widgets": 5,
        "api": true,
        "webhooks": true,
        "forms_advanced": true,
        "ambassador": false
      },
      "created_at": 1714507200,
      "updated_at": 1714593600
    }
  ]
}

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

POST /agency/projects HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "name": "Acme Dental"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 42,
    "name": "Acme Dental",
    "slug": "acme-dental",
    "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
    "is_active": true,
    "is_paused": false,
    "is_suspended": false,
    "features": {
      "asks": 500,
      "customers": 10000,
      "locations": 10,
      "members": 25,
      "links": 10,
      "tags": 50,
      "widgets": 5,
      "api": true,
      "webhooks": true,
      "forms_advanced": true,
      "ambassador": false
    },
    "created_at": 1714507200,
    "updated_at": 1714593600
  }
}

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}

DELETE /agency/projects/{project_id} HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200
}

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

POST /agency/projects/{project_id}/duplicate HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "name": "Acme Dental North"
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 43,
    "name": "Acme Dental North",
    "slug": "acme-dental-north",
    "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
    "is_active": true,
    "is_paused": false,
    "is_suspended": false,
    "features": {
      "asks": 500,
      "customers": 10000,
      "locations": 10,
      "members": 25,
      "links": 10,
      "tags": 50,
      "widgets": 5,
      "api": true,
      "webhooks": true,
      "forms_advanced": true,
      "ambassador": false
    },
    "created_at": 1714507200,
    "updated_at": 1714593600
  }
}

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

PUT /agency/projects/{project_id}/overrides HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 254

{
  "customers": 5000,
  "locations": 5,
  "members": 15,
  "links": 8,
  "tags": 40,
  "widgets": 3,
  "daily_email_requests": 100,
  "monthly_email_requests": 2000,
  "daily_sms_requests": 50,
  "monthly_sms_requests": 1000,
  "forms_advanced": true,
  "api": true,
  "webhooks": true,
  "ambassador": false
}

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 42,
    "name": "Acme Dental",
    "slug": "acme-dental",
    "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
    "is_active": true,
    "is_paused": false,
    "is_suspended": false,
    "features": {
      "asks": 500,
      "customers": 10000,
      "locations": 10,
      "members": 25,
      "links": 10,
      "tags": 50,
      "widgets": 5,
      "api": true,
      "webhooks": true,
      "forms_advanced": true,
      "ambassador": false
    },
    "created_at": 1714507200,
    "updated_at": 1714593600
  }
}

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

PUT /agency/projects/{project_id}/suspend HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 42,
    "name": "Acme Dental",
    "slug": "acme-dental",
    "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
    "is_active": true,
    "is_paused": false,
    "is_suspended": true,
    "features": {
      "asks": 500,
      "customers": 10000,
      "locations": 10,
      "members": 25,
      "links": 10,
      "tags": 50,
      "widgets": 5,
      "api": true,
      "webhooks": true,
      "forms_advanced": true,
      "ambassador": false
    },
    "created_at": 1714507200,
    "updated_at": 1714593600
  }
}

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

PUT /agency/projects/{project_id}/unsuspend HTTP/1.1
Host: api.moregoodreviews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "code": 200,
  "data": {
    "id": 42,
    "name": "Acme Dental",
    "slug": "acme-dental",
    "uuid": "9b58d4c2-8f4f-4a0c-9d55-53db5c9e0a21",
    "is_active": true,
    "is_paused": false,
    "is_suspended": false,
    "features": {
      "asks": 500,
      "customers": 10000,
      "locations": 10,
      "members": 25,
      "links": 10,
      "tags": 50,
      "widgets": 5,
      "api": true,
      "webhooks": true,
      "forms_advanced": true,
      "ambassador": false
    },
    "created_at": 1714507200,
    "updated_at": 1714593600
  }
}

PreviousAPI Reference NextClients

Last updated 2 months ago