Schemas – API Documentation

BadRequestDTO

statusCode

number

Example:

400

message

string

Example:

Bad Request

Example

{
  "statusCode": 400,
  "message": "Bad Request"
}

UnauthorizedDTO

statusCode

number

Example:

401

message

string

Example:

Invalid token: access token is invalid

error

string

Example:

Unauthorized

Example

 {
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

UnprocessableDTO

statusCode

number

Example:

422

message

array[string]

Example:

["Unprocessable Entity"]

error

string

Example:

Unprocessable Entity

Example

 {
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

IOnboardingDto

pending

boolean

required

Example:

true

haveWebsite

boolean

Example:

websiteUrl

string

Example:

industryServed

string

Example:

customerCount

string

Example:

tools

array[string]

Example:

location

boolean

Example:

conversationDemo

boolean

Example:

locationId

string

Example:

snapshotId

string

Example:

Example

 {
  "pending": "true",
  "haveWebsite": "",
  "websiteUrl": "",
  "industryServed": "",
  "customerCount": "",
  "tools": "",
  "location": "",
  "conversationDemo": "",
  "locationId": "",
  "snapshotId": ""
}

EndTrialDto

trial_end_req_by

string

required

Example:

trial_ended_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

Example

 {
  "trial_end_req_by": "",
  "trial_ended_on": "2023-08-02T00:00:00.000Z"
}

AgencyProAddOnDto

is_active

boolean

required

Example:

true

agency_pro_addon_subscription_id

string

required

Example:

price_a21hvDAS456asc

agency_pro_addon_active_plan

string

required

Allowed values:

reviews_monthly_150listing_monthly_50conversations_monthly_100priority-support_monthly_300priority-support_annual_300priority-support_monthly_300_legacypriority-support_annual_300_legacypriority-support_monthly_240_julyhipaa_monthly_297hipaa_annual_297hipaa_monthly_297_legacyagency-pro-plus_monthly_399agency-pro-plus_annual_399

Example:

agency-pro-plus_monthly_399

Example

 {
  "trial_end_req_by": "",
  "trial_ended_on": "2023-08-02T00:00:00.000Z"
}

ReactivationAttemptDto

attempted_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

attempted_by

string

required

Example:

john.doe@example.com

invoice_id

string

required

Example:

in_1NZoVqFpU9DlKp7RclfCqtIF

Example

 {
  "attempted_on": "2023-08-02T00:00:00.000Z",
  "attempted_by": "john.doe@example.com",
  "invoice_id": "in_1NZoVqFpU9DlKp7RclfCqtIF"
}

DowngradeDto

attempted_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

attempted_by

string

required

Example:

john.doe@example.com

previous_plan

string

required

Example:

$497 / month

current_plan

string

required

Example:

$297 / month

reason

string

required

Example:

Expensive

Example

{
  "attempted_on": "2023-08-02T00:00:00.000Z",
  "attempted_by": "john.doe@example.com",
  "previous_plan": "$497 / month",
  "current_plan": "$297 / month",
  "reason": "Expensive"
}

PauseSubscriptionInfoDto

requested_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

req_by

string

required

Example:

request by

reason

string

required

Example:

Expensive

status

string

required

Allowed values:

pendingapprovedrejected

Example:

pending

processed_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

Example

{
  "requested_on": "2023-08-02T00:00:00.000Z",
  "req_by": "request by",
  "reason": "Expensive",
  "status": "pending",
  "processed_on": "2023-08-02T00:00:00.000Z"
}

BillingInfoDto

first_trial_extension_processed_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

first_trial_extension_reason

string

Example:

Some reason for extending trial

second_trial_extension_processed_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

second_trial_extension_reason

string

Example:

Some reason for extending trial

pause_subscription_requested_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

pause_subscription_reason

string

Example:

Some reason for pausing subscription

pause_subscription_status

string

Allowed values:

pendingapprovedrejected

Example:

pending

pause_subscription_req_processed_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

pause_subscription_req_by

string

Example:

john.doe@example.com

end_trial_early

object

trial_end_req_by

string

required

Example:

trial_ended_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

agency_pro_addon

object

is_active

boolean

required

Example:

true

agency_pro_addon_subscription_id

string

required

Example:

price_a21hvDAS456asc

agency_pro_addon_active_plan

string

required

Allowed values:

Example:

agency-pro-plus_monthly_399

coupons_added

array[string]

reactivation_attempt

object

attempted_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

attempted_by

string

required

Example:

john.doe@example.com

invoice_id

string

required

Example:

in_1NZoVqFpU9DlKp7RclfCqtIF

downgrade

object

attempted_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

attempted_by

string

required

Example:

john.doe@example.com

previous_plan

string

required

Example:

$497 / month

current_plan

string

required

Example:

$297 / month

reason

string

required

Example:

Expensive

first_payment_date

string<date-time>

Example:

2023-08-02T00:00:00.000Z

pause_subscription_info

object

requested_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

req_by

string

required

Example:

request by

reason

string

required

Example:

Expensive

status

string

required

Allowed values:

pendingapprovedrejected

Example:

pending

processed_on

string<date-time>

required

Example:

2023-08-02T00:00:00.000Z

Example

{
  "first_trial_extension_processed_on": "2023-08-02T00:00:00.000Z",
  "first_trial_extension_reason": "Some reason for extending trial",
  "second_trial_extension_processed_on": "2023-08-02T00:00:00.000Z",
  "second_trial_extension_reason": "Some reason for extending trial",
  "pause_subscription_requested_on": "2023-08-02T00:00:00.000Z",
  "pause_subscription_reason": "Some reason for pausing subscription",
  "pause_subscription_status": "pending",
  "pause_subscription_req_processed_on": "2023-08-02T00:00:00.000Z",
  "pause_subscription_req_by": "john.doe@example.com",
  "end_trial_early": {
    "trial_end_req_by": "",
    "trial_ended_on": "2023-08-02T00:00:00.000Z"
  },
  "agency_pro_addon": {
    "is_active": true,
    "agency_pro_addon_subscription_id": "price_a21hvDAS456asc",
    "agency_pro_addon_active_plan": "agency-pro-plus_monthly_399"
  },
  "coupons_added": [
    "string"
  ],
  "reactivation_attempt": {
    "attempted_on": "2023-08-02T00:00:00.000Z",
    "attempted_by": "john.doe@example.com",
    "invoice_id": "in_1NZoVqFpU9DlKp7RclfCqtIF"
  },
  "downgrade": {
    "attempted_on": "2023-08-02T00:00:00.000Z",
    "attempted_by": "john.doe@example.com",
    "previous_plan": "$497 / month",
    "current_plan": "$297 / month",
    "reason": "Expensive"
  },
  "first_payment_date": "2023-08-02T00:00:00.000Z",
  "pause_subscription_info": {
    "requested_on": "2023-08-02T00:00:00.000Z",
    "req_by": "request by",
    "reason": "Expensive",
    "status": "pending",
    "processed_on": "2023-08-02T00:00:00.000Z"
  }
}

GetCompanyByIdSchema

string

Example:

seD4PfOuKoVMLkEZqohJ

name

string

Example:

Tesla inc

string

Example:

john@deo.com

logoUrl

string

Example:

https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873

phone

string

Example:

+1202-555-0107

website

string

Example:

https://www.tesla.com

domain

string

Example:

https://app.myawesomedomain.com

spareDomain

string

Example:

link.msgsndr.com

privacyPolicy

string

Example:

https://app.gohighlevel.com/privacy_policy

termsConditions

string

Example:

https://app.gohighlevel.com/terms-of-service

theme

string

Example:

default-dark-v1

address

string

Example:

3500 Deer Creek Road

city

string

Example:

Palo Alto

postalCode

string

Example:

94304

country

string

Example:

state

string

Example:

timezone

string

Example:

US/Central

relationshipNumber

string

Example:

x-xxx-xxx

faviconUrl

string

Example:

https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873

subdomain

string

Example:

https://app.myawesomedomain.com/subdomain

plan

number

Example:

currency

string

Example:

customerType

string

Example:

agency

termsOfServiceVersion

string

Example:

06/01/2022

termsOfServiceAcceptedBy

string

Example:

SDfdf355Dfggdee

twilioTrialMode

boolean

Example:

true

twilioFreeCredits

number

Example:

100

termsOfServiceAcceptedDate

string

Example:

privacyPolicyVersion

string

Example:

06/01/2022

privacyPolicyAcceptedBy

string

Example:

SDfdf355Dfggdee

privacyPolicyAcceptedDate

string

Example:

affiliatePolicyVersion

string

Example:

06/01/2022

affiliatePolicyAcceptedBy

string

Example:

SDfdf355Dfggdee

affiliatePolicyAcceptedDate

string

Example:

isReselling

boolean

Example:

true

onboardingInfo

object

Example:

pending

boolean

required

Example:

true

haveWebsite

boolean

Example:

websiteUrl

string

Example:

industryServed

string

Example:

customerCount

string

Example:

tools

array[string]

Example:

location

boolean

Example:

conversationDemo

boolean

Example:

locationId

string

Example:

snapshotId

string

Example:

stripeId

string

Example:

upgradeEnabledForClients

boolean

Flag to set if upgrade plan is enabled

Example:

true

cancelEnabledForClients

boolean

Flag to set if cancel plan is enabled

Example:

true

autoSuspendEnabled

boolean

Flag to set if auto suspend is enabled

Example:

true

saasSettings

object

Saas Settings

Example:

{"agencyDashboardVisibleTo":"string","stripeConnectInitiatedBy":"string"}

stripeActivePlan

string

Example:

agency_monthly_297

stripeConnectId

string

Example:

enableDepreciatedFeatures

boolean

Example:

true

premiumUpgraded

boolean

If you want to enable / disable Priority Support for any agency. Default value is false.

Default:

false

Example:

false

status

string

Example:

active-trial

locationCount

number

Example:

disableEmailService

boolean

Example:

false

billingInfo

object

first_trial_extension_processed_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

first_trial_extension_reason

string

Example:

Some reason for extending trial

second_trial_extension_processed_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

second_trial_extension_reason

string

Example:

Some reason for extending trial

pause_subscription_requested_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

pause_subscription_reason

string

Example:

Some reason for pausing subscription

pause_subscription_status

string

Allowed values:

pendingapprovedrejected

Example:

pending

pause_subscription_req_processed_on

string<date-time>

Example:

2023-08-02T00:00:00.000Z

pause_subscription_req_by

string

Example:

john.doe@example.com

end_trial_early

object

agency_pro_addon

object

coupons_added

array[string]

reactivation_attempt

object

downgrade

object

first_payment_date

string<date-time>

Example:

2023-08-02T00:00:00.000Z

pause_subscription_info

object

Example

{
  "id": "seD4PfOuKoVMLkEZqohJ",
  "name": "Tesla inc",
  "email": "john@deo.com",
  "logoUrl": "https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873",
  "phone": "+1202-555-0107",
  "website": "https://www.tesla.com",
  "domain": "https://app.myawesomedomain.com",
  "spareDomain": "link.msgsndr.com",
  "privacyPolicy": "https://app.gohighlevel.com/privacy_policy",
  "termsConditions": "https://app.gohighlevel.com/terms-of-service",
  "theme": "default-dark-v1",
  "address": "3500 Deer Creek Road",
  "city": "Palo Alto",
  "postalCode": "94304",
  "country": "US",
  "state": "CA",
  "timezone": "US/Central",
  "relationshipNumber": "x-xxx-xxx",
  "faviconUrl": "https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873",
  "subdomain": "https://app.myawesomedomain.com/subdomain",
  "plan": 1,
  "currency": "",
  "customerType": "agency",
  "termsOfServiceVersion": "06/01/2022",
  "termsOfServiceAcceptedBy": "SDfdf355Dfggdee",
  "twilioTrialMode": true,
  "twilioFreeCredits": 100,
  "termsOfServiceAcceptedDate": "",
  "privacyPolicyVersion": "06/01/2022",
  "privacyPolicyAcceptedBy": "SDfdf355Dfggdee",
  "privacyPolicyAcceptedDate": "",
  "affiliatePolicyVersion": "06/01/2022",
  "affiliatePolicyAcceptedBy": "SDfdf355Dfggdee",
  "affiliatePolicyAcceptedDate": "",
  "isReselling": true,
  "onboardingInfo": {
    "pending": "true",
    "haveWebsite": "",
    "websiteUrl": "",
    "industryServed": "",
    "customerCount": "",
    "tools": "",
    "location": "",
    "conversationDemo": "",
    "locationId": "",
    "snapshotId": ""
  },
  "stripeId": "",
  "upgradeEnabledForClients": true,
  "cancelEnabledForClients": true,
  "autoSuspendEnabled": true,
  "saasSettings": {
    "agencyDashboardVisibleTo": "string",
    "stripeConnectInitiatedBy": "string"
  },
  "stripeActivePlan": "agency_monthly_297",
  "stripeConnectId": "",
  "enableDepreciatedFeatures": true,
  "premiumUpgraded": false,
  "status": "active-trial",
  "locationCount": 10,
  "disableEmailService": false,
  "billingInfo": {
    "first_trial_extension_processed_on": "2023-08-02T00:00:00.000Z",
    "first_trial_extension_reason": "Some reason for extending trial",
    "second_trial_extension_processed_on": "2023-08-02T00:00:00.000Z",
    "second_trial_extension_reason": "Some reason for extending trial",
    "pause_subscription_requested_on": "2023-08-02T00:00:00.000Z",
    "pause_subscription_reason": "Some reason for pausing subscription",
    "pause_subscription_status": "pending",
    "pause_subscription_req_processed_on": "2023-08-02T00:00:00.000Z",
    "pause_subscription_req_by": "john.doe@example.com",
    "end_trial_early": {
      "trial_end_req_by": "",
      "trial_ended_on": "2023-08-02T00:00:00.000Z"
    },
    "agency_pro_addon": {
      "is_active": true,
      "agency_pro_addon_subscription_id": "price_a21hvDAS456asc",
      "agency_pro_addon_active_plan": "agency-pro-plus_monthly_399"
    },
    "coupons_added": [
      "string"
    ],
    "reactivation_attempt": {
      "attempted_on": "2023-08-02T00:00:00.000Z",
      "attempted_by": "john.doe@example.com",
      "invoice_id": "in_1NZoVqFpU9DlKp7RclfCqtIF"
    },
    "downgrade": {
      "attempted_on": "2023-08-02T00:00:00.000Z",
      "attempted_by": "john.doe@example.com",
      "previous_plan": "$497 / month",
      "current_plan": "$297 / month",
      "reason": "Expensive"
    },
    "first_payment_date": "2023-08-02T00:00:00.000Z",
    "pause_subscription_info": {
      "requested_on": "2023-08-02T00:00:00.000Z",
      "req_by": "request by",
      "reason": "Expensive",
      "status": "pending",
      "processed_on": "2023-08-02T00:00:00.000Z"
    }
  }
}

GetCompanyByIdSuccessfulResponseDto

company

object

string

Example:

seD4PfOuKoVMLkEZqohJ

name

string

Example:

Tesla inc

string

Example:

john@deo.com

logoUrl

string

Example:

https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873

phone

string

Example:

+1202-555-0107

website

string

Example:

https://www.tesla.com

domain

string

Example:

https://app.myawesomedomain.com

spareDomain

string

Example:

link.msgsndr.com

privacyPolicy

string

Example:

https://app.gohighlevel.com/privacy_policy

termsConditions

string

Example:

https://app.gohighlevel.com/terms-of-service

theme

string

Example:

default-dark-v1

address

string

Example:

3500 Deer Creek Road

city

string

Example:

Palo Alto

postalCode

string

Example:

94304

country

string

Example:

state

string

Example:

timezone

string

Example:

US/Central

relationshipNumber

string

Example:

x-xxx-xxx

faviconUrl

string

Example:

https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873

subdomain

string

Example:

https://app.myawesomedomain.com/subdomain

plan

number

Example:

currency

string

Example:

customerType

string

Example:

agency

termsOfServiceVersion

string

Example:

06/01/2022

termsOfServiceAcceptedBy

string

Example:

SDfdf355Dfggdee

twilioTrialMode

boolean

Example:

true

twilioFreeCredits

number

Example:

100

termsOfServiceAcceptedDate

string

Example:

privacyPolicyVersion

string

Example:

06/01/2022

privacyPolicyAcceptedBy

string

Example:

SDfdf355Dfggdee

privacyPolicyAcceptedDate

string

Example:

affiliatePolicyVersion

string

Example:

06/01/2022

affiliatePolicyAcceptedBy

string

Example:

SDfdf355Dfggdee

affiliatePolicyAcceptedDate

string

Example:

isReselling

boolean

Example:

true

onboardingInfo

object

Example:

stripeId

string

Example:

upgradeEnabledForClients

boolean

Flag to set if upgrade plan is enabled

Example:

true

cancelEnabledForClients

boolean

Flag to set if cancel plan is enabled

Example:

true

autoSuspendEnabled

boolean

Flag to set if auto suspend is enabled

Example:

true

saasSettings

object

Saas Settings

Example:

{"agencyDashboardVisibleTo":"string","stripeConnectInitiatedBy":"string"}

stripeActivePlan

string

Example:

agency_monthly_297

stripeConnectId

string

Example:

enableDepreciatedFeatures

boolean

Example:

true

premiumUpgraded

boolean

If you want to enable / disable Priority Support for any agency. Default value is false.

Default:

false

Example:

false

status

string

Example:

active-trial

locationCount

number

Example:

disableEmailService

boolean

Example:

false

billingInfo

object

Example

{
  "company": {
    "id": "seD4PfOuKoVMLkEZqohJ",
    "name": "Tesla inc",
    "email": "john@deo.com",
    "logoUrl": "https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873",
    "phone": "+1202-555-0107",
    "website": "https://www.tesla.com",
    "domain": "https://app.myawesomedomain.com",
    "spareDomain": "link.msgsndr.com",
    "privacyPolicy": "https://app.gohighlevel.com/privacy_policy",
    "termsConditions": "https://app.gohighlevel.com/terms-of-service",
    "theme": "default-dark-v1",
    "address": "3500 Deer Creek Road",
    "city": "Palo Alto",
    "postalCode": "94304",
    "country": "US",
    "state": "CA",
    "timezone": "US/Central",
    "relationshipNumber": "x-xxx-xxx",
    "faviconUrl": "https://firebasestorage.googleapis.com/v0/b/highlevel-staging.appspot.com/o/companyPhotos%2F5DP4iH6HLkQsiKESj6rh.gif?alt=media&token=2aec9720-59a7-46af-a187-d4a2774ee873",
    "subdomain": "https://app.myawesomedomain.com/subdomain",
    "plan": 1,
    "currency": "",
    "customerType": "agency",
    "termsOfServiceVersion": "06/01/2022",
    "termsOfServiceAcceptedBy": "SDfdf355Dfggdee",
    "twilioTrialMode": true,
    "twilioFreeCredits": 100,
    "termsOfServiceAcceptedDate": "",
    "privacyPolicyVersion": "06/01/2022",
    "privacyPolicyAcceptedBy": "SDfdf355Dfggdee",
    "privacyPolicyAcceptedDate": "",
    "affiliatePolicyVersion": "06/01/2022",
    "affiliatePolicyAcceptedBy": "SDfdf355Dfggdee",
    "affiliatePolicyAcceptedDate": "",
    "isReselling": true,
    "onboardingInfo": "",
    "stripeId": "",
    "upgradeEnabledForClients": true,
    "cancelEnabledForClients": true,
    "autoSuspendEnabled": true,
    "saasSettings": {
      "agencyDashboardVisibleTo": "string",
      "stripeConnectInitiatedBy": "string"
    },
    "stripeActivePlan": "agency_monthly_297",
    "stripeConnectId": "",
    "enableDepreciatedFeatures": true,
    "premiumUpgraded": false,
    "status": "active-trial",
    "locationCount": 10,
    "disableEmailService": false,
    "billingInfo": {
      "first_trial_extension_processed_on": "2023-08-02T00:00:00.000Z",
      "first_trial_extension_reason": "Some reason for extending trial",
      "second_trial_extension_processed_on": "2023-08-02T00:00:00.000Z",
      "second_trial_extension_reason": "Some reason for extending trial",
      "pause_subscription_requested_on": "2023-08-02T00:00:00.000Z",
      "pause_subscription_reason": "Some reason for pausing subscription",
      "pause_subscription_status": "pending",
      "pause_subscription_req_processed_on": "2023-08-02T00:00:00.000Z",
      "pause_subscription_req_by": "john.doe@example.com",
      "end_trial_early": {},
      "agency_pro_addon": {},
      "coupons_added": [
        null
      ],
      "reactivation_attempt": {},
      "downgrade": {},
      "first_payment_date": "2023-08-02T00:00:00.000Z",
      "pause_subscription_info": {}
    }
  }
}