MENU navbar-image

Introduction

API documentation for developers

This documentation aims to provide all the information you need to work with the Smarter Launch API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Our API is currently not available for external access outside of the Smarter Launch application.

Service Plan

API for Service Plans

List

requires authentication

Shows the list of Service Plans with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/service-plans" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/service-plans

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 7

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 8

sort_by   string  optional  

The column name. Example : name Example: esse

sort_order   string  optional  

The order in which you want your records. Example : asc Example: repellat

search   string  optional  

The general search, it will find matching string. Example : home Example: voluptatem

string   string  optional  

The filter for service plans with status in statuses_uuid. Example: ["725d1dcd-54ad-3a8b-a28e-830c43d8ed6c", "b033658c-4532-3dd7-9be7-64433580eda6"]

Get

requires authentication

Shows the specified Service Plan.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/service-plans/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/service-plans/{servicePlan_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Create

requires authentication

Store a newly created Service Plan.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/service-plans" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Premium Service Plan\",
    \"display_name\": \"dicta\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"company_locations_uuid\": [
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\",
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\"
    ],
    \"categories_uuid\": [
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\",
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\"
    ],
    \"default_contract_term_units\": 172
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Premium Service Plan',
            'display_name' => 'dicta',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'company_locations_uuid' => [
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
            ],
            'categories_uuid' => [
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
            ],
            'default_contract_term_units' => 172.0,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Premium Service Plan",
    "display_name": "dicta",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "company_locations_uuid": [
        "10933939-447e-3d2c-944f-b3ef57dc6eeb",
        "10933939-447e-3d2c-944f-b3ef57dc6eeb"
    ],
    "categories_uuid": [
        "10933939-447e-3d2c-944f-b3ef57dc6eeb",
        "10933939-447e-3d2c-944f-b3ef57dc6eeb"
    ],
    "default_contract_term_units": 172
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/service-plans

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of Service Plan. Example: Premium Service Plan

display_name   string  optional  

Example: dicta

description   string  optional  

The description of Service Plan. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

company_locations_uuid   string[]  optional  

List of company_location_uuid.

categories_uuid   string[]  optional  

List of category_uuid. Example:

default_contract_term   string  optional  
default_contract_term_units   number  optional  

Example: 172

Duplicate

requires authentication

This endpoint lets user to duplicate service plan and set into a draft mode

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/duplicate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/service-plans/{servicePlan_uuid}/duplicate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

service_plan_uuid   string  optional  

uuid required The uuid of the service plan. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update

requires authentication

Perform a full field update for the specified Service Plan.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/service-plans/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Premium Service Plan\",
    \"display_name\": \"dolor\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"company_locations_uuid\": [
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\",
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\"
    ],
    \"categories_uuid\": [
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\",
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\"
    ],
    \"default_contract_term_units\": 0,
    \"save_as\": \"SERVICE_PLAN_DRAFT\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Premium Service Plan',
            'display_name' => 'dolor',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'company_locations_uuid' => [
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
            ],
            'categories_uuid' => [
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
            ],
            'default_contract_term_units' => 0.0,
            'save_as' => 'SERVICE_PLAN_DRAFT',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Premium Service Plan",
    "display_name": "dolor",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "company_locations_uuid": [
        "10933939-447e-3d2c-944f-b3ef57dc6eeb",
        "10933939-447e-3d2c-944f-b3ef57dc6eeb"
    ],
    "categories_uuid": [
        "10933939-447e-3d2c-944f-b3ef57dc6eeb",
        "10933939-447e-3d2c-944f-b3ef57dc6eeb"
    ],
    "default_contract_term_units": 0,
    "save_as": "SERVICE_PLAN_DRAFT"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/service-plans/{servicePlan_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Body Parameters

name   string   

The name of Service Plan. Example: Premium Service Plan

display_name   string  optional  

Example: dolor

description   string  optional  

The description of Service Plan. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

company_locations_uuid   string[]  optional  

List of company_location_uuid.

categories_uuid   string[]  optional  

List of category_uuid. Example:

default_contract_term   string  optional  
default_contract_term_units   number  optional  

Example: 0

save_as   string  optional  

Example: SERVICE_PLAN_DRAFT

Must be one of:
  • SERVICE_PLAN_DRAFT
  • SERVICE_PLAN_ACTIVE
  • SERVICE_PLAN_ARCHIVED

Patch

requires authentication

Perform a patch for the specified Service Plan.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Premium Service Plan\",
    \"display_name\": \"voluptate\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"company_locations_uuid\": [
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\",
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\"
    ],
    \"categories_uuid\": [
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\",
        \"10933939-447e-3d2c-944f-b3ef57dc6eeb\"
    ],
    \"default_contract_term_units\": 51.754838,
    \"save_as\": \"SERVICE_PLAN_DRAFT\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Premium Service Plan',
            'display_name' => 'voluptate',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'company_locations_uuid' => [
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
            ],
            'categories_uuid' => [
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
                '10933939-447e-3d2c-944f-b3ef57dc6eeb',
            ],
            'default_contract_term_units' => 51.754838,
            'save_as' => 'SERVICE_PLAN_DRAFT',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Premium Service Plan",
    "display_name": "voluptate",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "company_locations_uuid": [
        "10933939-447e-3d2c-944f-b3ef57dc6eeb",
        "10933939-447e-3d2c-944f-b3ef57dc6eeb"
    ],
    "categories_uuid": [
        "10933939-447e-3d2c-944f-b3ef57dc6eeb",
        "10933939-447e-3d2c-944f-b3ef57dc6eeb"
    ],
    "default_contract_term_units": 51.754838,
    "save_as": "SERVICE_PLAN_DRAFT"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Body Parameters

name   string  optional  

requiredThe name of Service Plan. Example: Premium Service Plan

display_name   string  optional  

Example: voluptate

description   string  optional  

The description of Service Plan. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

company_locations_uuid   string[]  optional  

List of company_location_uuid.

categories_uuid   string[]  optional  

List of category_uuid. Example:

settings   object  optional  
default_contract_term   string  optional  
default_contract_term_units   number  optional  

Example: 51.754838

save_as   string  optional  

Example: SERVICE_PLAN_DRAFT

Must be one of:
  • SERVICE_PLAN_DRAFT
  • SERVICE_PLAN_ACTIVE
  • SERVICE_PLAN_ARCHIVED

Save as Draft

requires authentication

Save as Draft the specified Service Plan.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/draft" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/draft';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/draft"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}/draft

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Publish

requires authentication

Publish the specified Service Plan.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/publish" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/publish';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/publish"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}/publish

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Archived

requires authentication

Archived the specified Service Plan.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/archive" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/archive';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/archive"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}/archive

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Unarchived

requires authentication

Unarchived the specified Service Plan.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/unarchive" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/unarchive';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/unarchive"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}/unarchive

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Delete

requires authentication

Remove the specified Service Plan.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/service-plans/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/service-plans/{servicePlan_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Decline Reason

API for Decline Reason

List

requires authentication

Shows the list of decline reasons with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/decline-reasons

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 1

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 1

sort_by   string  optional  

The column name. Example : name Example: qui

sort_order   string  optional  

The order in which you want your records. Example : asc Example: animi

search   string  optional  

The general search, it will find matching string. Example : home Example: quos

Show

requires authentication

Show a single decline reason.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/decline-reasons/{declineReason_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

declineReason_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created decline reasons.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"aspernatur\",
    \"description\": \"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'aspernatur',
            'description' => 'Lorem, ipsum dolor sit amet consectetur adipisicing elit.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "aspernatur",
    "description": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/decline-reasons

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

title   string   

The title of the decline reasons. Example : So Expensive Example: aspernatur

description   object  optional  

The description of the decline reasons. Example: Lorem, ipsum dolor sit amet consectetur adipisicing elit.

Update

requires authentication

Update a decline reason.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"similique\",
    \"description\": \"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'similique',
            'description' => 'Lorem, ipsum dolor sit amet consectetur adipisicing elit.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "similique",
    "description": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/decline-reasons/{declineReason_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

declineReason_uuid   integer   

Example: 1

Body Parameters

title   string   

The title of the decline reasons. Example : "So Expensive" Example: similique

description   object  optional  

The description of the decline reasons. Example: Lorem, ipsum dolor sit amet consectetur adipisicing elit.

Patch

requires authentication

Patch a company decline reason.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"vel\",
    \"description\": \"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'vel',
            'description' => 'Lorem, ipsum dolor sit amet consectetur adipisicing elit.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "vel",
    "description": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/decline-reasons/{declineReason_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

declineReason_uuid   integer   

Example: 1

Body Parameters

title   string   

The title of the decline reasons. Example : So Expensive Example: vel

description   object  optional  

The description of the decline reasons. Example: Lorem, ipsum dolor sit amet consectetur adipisicing elit.

Delete

requires authentication

Delete a decline reason.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/decline-reasons/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/decline-reasons/{declineReason_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

declineReason_uuid   integer   

Example: 1

Automation

API for Automation

List

requires authentication

Shows the list of Automations with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/automations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/automations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/automations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/automations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 13

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 4

sort_by   string  optional  

The column name. Example : name Example: voluptas

sort_order   string  optional  

The order in which you want your records. Example : asc Example: neque

search   string  optional  

The general search, it will find matching string. Example : home Example: quidem

is_enabled   string  optional  

boolean Filter by enabled status. Example : true Example: velit

Create

requires authentication

Store a newly created Automation.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/automations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"type\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"actions\": [
        \"vitae\"
    ],
    \"filters\": [
        \"et\"
    ],
    \"triggers\": [
        \"adipisci\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/automations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Small Pests',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'type' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'actions' => [
                'vitae',
            ],
            'filters' => [
                'et',
            ],
            'triggers' => [
                'adipisci',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/automations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "type": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "actions": [
        "vitae"
    ],
    "filters": [
        "et"
    ],
    "triggers": [
        "adipisci"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/automations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the automation. Example: Small Pests

description   string  optional  

The description of the automation. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

type   string   

The type of the automation. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

actions   string[]  optional  

of object required The actions of automation. Example : [{action: "SEND_EMAIL", value: ["john@smarterlaunch.com", "smith@smarterlaunch.com"], settings: {body: "Please follow-up with this and set an appointment."}}]

filters   string[]  optional  

of object required The filters of automation. Example : [{type: "CUSTOMER",operator: "IS",value: "3245d630-24fd-11ec-accd-e397aec85c7f",}, {type: "USER",operator: "IS_ONE_OF",value: ["3245d630-24fd-11ec-accd-e397aec85c7f", "3245d630-24fd-11ec-accd-e397aec85c7h"]}]

triggers   string[]  optional  

of object required The triggers of automation. Example : [{type: "CUSTOMER",operator: "IS_CHANGED_TO",value: "3245d630-24fd-11ec-accd-e397aec85c7f"}]

Get

requires authentication

Display the specified Automation.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/automations/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/automations/3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/automations/{automation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

automation_uuid   integer   

Example: 3

Update

requires authentication

Modify the specified Automation.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"type\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"actions\": [
        \"ad\"
    ],
    \"filters\": [
        \"nihil\"
    ],
    \"triggers\": [
        \"laborum\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/automations/3';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Small Pests',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'type' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'actions' => [
                'ad',
            ],
            'filters' => [
                'nihil',
            ],
            'triggers' => [
                'laborum',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "type": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "actions": [
        "ad"
    ],
    "filters": [
        "nihil"
    ],
    "triggers": [
        "laborum"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/automations/{automation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

automation_uuid   integer   

Example: 3

automationUuid   string   

The uuid of the automation. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the automation. Example: Small Pests

description   string  optional  

The description of the automation. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

type   string   

The type of the automation. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

actions   string[]  optional  

of object required The actions of automation. Example : [{action: "SEND_EMAIL",value: ["john@smarterlaunch.com", "smith@smarterlaunch.com"], settings: {body: "Please follow-up with this and set an appointment."}}]

filters   string[]  optional  

of object required The filters of automation. Example : [{type: "CUSTOMER",operator: "IS", value: "3245d630-24fd-11ec-accd-e397aec85c7f",}, {type: "USER",operator: "IS_ONE_OF", value: ["3245d630-24fd-11ec-accd-e397aec85c7f", "3245d630-24fd-11ec-accd-e397aec85c7h"]}]

triggers   string[]  optional  

of object required The triggers of automation. Example : [{type: "CUSTOMER",operator: "IS_CHANGED_TO",value: "3245d630-24fd-11ec-accd-e397aec85c7f"}]

Patch

requires authentication

Perform patches for the specified Automation.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"type\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"actions\": [
        \"ut\"
    ],
    \"filters\": [
        \"amet\"
    ],
    \"triggers\": [
        \"esse\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/automations/3';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Small Pests',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'type' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'actions' => [
                'ut',
            ],
            'filters' => [
                'amet',
            ],
            'triggers' => [
                'esse',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "type": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "actions": [
        "ut"
    ],
    "filters": [
        "amet"
    ],
    "triggers": [
        "esse"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/automations/{automation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

automation_uuid   integer   

Example: 3

automationUuid   string   

The uuid of the automation. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string  optional  

The name of the automation. Example: Small Pests

description   string  optional  

The description of the automation. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

type   string  optional  

The type of the automation. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

actions   string[]  optional  

of object The actions of automation. Example : [{action: "SEND_EMAIL", value: ["john@smarterlaunch.com", "smith@smarterlaunch.com"], settings: {body: "Please follow-up with this and set an appointment."}}]

filters   string[]  optional  

of object The filters of automation. Example : [{type: "CUSTOMER",operator: "IS", value: "3245d630-24fd-11ec-accd-e397aec85c7f",}, {type: "USER",operator: "IS_ONE_OF", value: ["3245d630-24fd-11ec-accd-e397aec85c7f", "3245d630-24fd-11ec-accd-e397aec85c7h"]}]

triggers   string[]  optional  

of object The triggers of automation. Example : [{type: "CUSTOMER",operator: "IS_CHANGED_TO",value: "3245d630-24fd-11ec-accd-e397aec85c7f"}]

Delete

requires authentication

Remove the specified Automation.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/automations/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/automations/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/automations/{automation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

automation_uuid   integer   

Example: 3

Heartbeat

API for Heartbeat

Lock

requires authentication

Lock a specific item of given the type for editing

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/heartbeat" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"\\\"Proposal\\\"\",
    \"uuid\": \"\\\"f26834b1-b086-3c99-adc7-b1660383a3fd\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/heartbeat';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => '"Proposal"',
            'uuid' => '"f26834b1-b086-3c99-adc7-b1660383a3fd"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/heartbeat"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "\"Proposal\"",
    "uuid": "\"f26834b1-b086-3c99-adc7-b1660383a3fd\""
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/heartbeat

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

The type of endpoint to be locked. Example: "Proposal"

uuid   string   

The uuid of the specific item. Example: "f26834b1-b086-3c99-adc7-b1660383a3fd"

Unlock

requires authentication

Unlock a specific item of given the type for editing

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/heartbeat" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"type\": \"\\\"Proposal\\\"\",
    \"uuid\": \"\\\"f26834b1-b086-3c99-adc7-b1660383a3fd\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/heartbeat';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'type' => '"Proposal"',
            'uuid' => '"f26834b1-b086-3c99-adc7-b1660383a3fd"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/heartbeat"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "type": "\"Proposal\"",
    "uuid": "\"f26834b1-b086-3c99-adc7-b1660383a3fd\""
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

DELETE api/v1/heartbeat

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

type   string   

The type of endpoint to be unlocked. Example: "Proposal"

uuid   string   

The uuid of the specific item. Example: "f26834b1-b086-3c99-adc7-b1660383a3fd"

Role

API for role details

List / Fetch

requires authentication

Shows the list of role or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"name\": \"admin\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/roles';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'name' => 'admin',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "name": "admin"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string  optional  

optional The uuid of the role. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

name   string  optional  

optional The role name. Example: admin

List / Fetch

requires authentication

Shows the list of role or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"name\": \"admin\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/roles/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'name' => 'admin',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/roles/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "name": "admin"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/roles/{roleUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roleUuid   integer   

Example: 1

Body Parameters

uuid   string  optional  

optional The uuid of the role. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

name   string  optional  

optional The role name. Example: admin

Create / Update role.

requires authentication

This endpoint lets user to create/update role.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/roles" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"admin\",
    \"uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/roles';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'admin',
            'uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/roles"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "admin",
    "uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/roles

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the role. Example: admin

uuid   string  optional  

optional The uuid of the role. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

Create / Update role.

requires authentication

This endpoint lets user to create/update role.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"admin\",
    \"uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/roles/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'admin',
            'uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/roles/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "admin",
    "uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/roles/{roleUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roleUuid   integer   

Example: 1

Body Parameters

name   string   

The name of the role. Example: admin

uuid   string  optional  

optional The uuid of the role. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/roles/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/roles/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/roles/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/roles/{roleUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

roleUuid   integer   

Example: 1

uuid   string   

The uuid of the role. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Review

API for Review

List

requires authentication

Shows the list of review with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/reviews" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/reviews

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 12

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 19

sort_by   string  optional  

The column name. Example : name Example: quisquam

sort_order   string  optional  

The order in which you want your records. Example : asc Example: officia

search   string  optional  

The general search, it will find matching string. Example : home Example: aperiam

is_all_location   string  optional  

boolean Will get all reviews that is not company location specific. Example : true Example: laudantium

Show

requires authentication

Show a single review.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/reviews/{review_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

review_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created review.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=doloribus"\
    --form "message=et"\
    --form "rate=non"\
    --form "external_photo_url=https://ratke.com/esse-modi-quasi-veritatis-rem-aut.html"\
    --form "position=15"\
    --form "company_location_uuid=660885a8-4fa4-3218-b4bc-034c0a53d8f8"\
    --form "photo=@/tmp/phpafazH4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'doloribus'
            ],
            [
                'name' => 'message',
                'contents' => 'et'
            ],
            [
                'name' => 'rate',
                'contents' => 'non'
            ],
            [
                'name' => 'external_photo_url',
                'contents' => 'https://ratke.com/esse-modi-quasi-veritatis-rem-aut.html'
            ],
            [
                'name' => 'position',
                'contents' => '15'
            ],
            [
                'name' => 'company_location_uuid',
                'contents' => '660885a8-4fa4-3218-b4bc-034c0a53d8f8'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/phpafazH4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'doloribus');
body.append('message', 'et');
body.append('rate', 'non');
body.append('external_photo_url', 'https://ratke.com/esse-modi-quasi-veritatis-rem-aut.html');
body.append('position', '15');
body.append('company_location_uuid', '660885a8-4fa4-3218-b4bc-034c0a53d8f8');
body.append('photo', document.querySelector('input[name="photo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/reviews

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the customer/reviewer. Example : "My Review" Example: doloribus

message   string  optional  

The message of the review. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: et

rate   string   

The rate of the review ranging from 0-5. Example : 5 Example: non

photo   file  optional  

The file photo of the review..jpg, .jpeg, .png Example: /tmp/phpafazH4

external_photo_url   string  optional  

An external url of an image as review/photo. Example: https://ratke.com/esse-modi-quasi-veritatis-rem-aut.html

position   integer  optional  

The the position of the review. Example : 2 Example: 15

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: 660885a8-4fa4-3218-b4bc-034c0a53d8f8

Update

requires authentication

Update a review.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=mollitia"\
    --form "message=qui"\
    --form "rate=nulla"\
    --form "external_photo_url=http://www.crooks.com/iusto-dolore-et-nulla-modi-cum-fuga-sunt"\
    --form "position=16"\
    --form "company_location_uuid=3d876684-5b79-3ddb-b615-f3853efd24f6"\
    --form "photo=@/tmp/phpapNqN3" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews/1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'mollitia'
            ],
            [
                'name' => 'message',
                'contents' => 'qui'
            ],
            [
                'name' => 'rate',
                'contents' => 'nulla'
            ],
            [
                'name' => 'external_photo_url',
                'contents' => 'http://www.crooks.com/iusto-dolore-et-nulla-modi-cum-fuga-sunt'
            ],
            [
                'name' => 'position',
                'contents' => '16'
            ],
            [
                'name' => 'company_location_uuid',
                'contents' => '3d876684-5b79-3ddb-b615-f3853efd24f6'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/phpapNqN3', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'mollitia');
body.append('message', 'qui');
body.append('rate', 'nulla');
body.append('external_photo_url', 'http://www.crooks.com/iusto-dolore-et-nulla-modi-cum-fuga-sunt');
body.append('position', '16');
body.append('company_location_uuid', '3d876684-5b79-3ddb-b615-f3853efd24f6');
body.append('photo', document.querySelector('input[name="photo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/reviews/{review_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

review_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the customer/reviewer. Example : "My Review" Example: mollitia

message   string  optional  

The message of the review. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: qui

rate   string   

The rate of the review ranging from 0-5. Example : 5 Example: nulla

photo   file  optional  

The file photo of the review..jpg, .jpeg, .png Example: /tmp/phpapNqN3

external_photo_url   string  optional  

An external url of an image as review/photo. Example: http://www.crooks.com/iusto-dolore-et-nulla-modi-cum-fuga-sunt

position   integer  optional  

The the position of the review. Example : 2 Example: 16

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: 3d876684-5b79-3ddb-b615-f3853efd24f6

Patch Index

requires authentication

Performs specific updates for review ranking

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/reviews

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

review_ranking_list   string  optional  

string[] A dictionary of uuids with uuid as key and rank as the value. Example : {"69e56cdf-cea8-4356-b35d-58d610aba886" : 1, "9c578b77-916a-4620-a246-fa951f422912" : 2} Example: ab

Patch

requires authentication

Patch a company review.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"aspernatur\",
    \"message\": \"eaque\",
    \"rate\": \"doloribus\",
    \"external_photo_url\": \"http:\\/\\/fadel.com\\/asperiores-iure-non-in-possimus-laborum\",
    \"position\": 20,
    \"company_location_uuid\": \"a91d7ff0-e423-3220-84fa-b1e6a1e4c4a0\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'aspernatur',
            'message' => 'eaque',
            'rate' => 'doloribus',
            'external_photo_url' => 'http://fadel.com/asperiores-iure-non-in-possimus-laborum',
            'position' => 20,
            'company_location_uuid' => 'a91d7ff0-e423-3220-84fa-b1e6a1e4c4a0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "aspernatur",
    "message": "eaque",
    "rate": "doloribus",
    "external_photo_url": "http:\/\/fadel.com\/asperiores-iure-non-in-possimus-laborum",
    "position": 20,
    "company_location_uuid": "a91d7ff0-e423-3220-84fa-b1e6a1e4c4a0"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/reviews/{review_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

review_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the customer/reviewer. Example : "My Review" Example: aspernatur

message   string  optional  

The message of the review. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: eaque

rate   string  optional  

The rate of the review ranging from 0-5. Example : 5 Example: doloribus

external_photo_url   string  optional  

An external url of an image as review/photo. Example: http://fadel.com/asperiores-iure-non-in-possimus-laborum

position   integer  optional  

The the position of the review. Example : 2 Example: 20

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: a91d7ff0-e423-3220-84fa-b1e6a1e4c4a0

Delete

requires authentication

Delete a review.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/reviews/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/reviews/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/reviews/{review_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

review_uuid   integer   

Example: 1

Form Field

API for Form field

List

requires authentication

Shows the list of form fields with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/forms/{form_uuid}/fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

page   integer  optional  

The page number. Example : 1 Example: 18

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 18

sort_by   string  optional  

The column name. Example : name Example: quaerat

sort_order   string  optional  

The order in which you want your records. Example : asc Example: necessitatibus

search   string  optional  

The general search, it will find matching string. Example : "Quality Assurance" Example: ut

Show

requires authentication

Show a single form field.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/abceea7e-48c3-32cb-b552-d9a0482c19c5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/abceea7e-48c3-32cb-b552-d9a0482c19c5';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/abceea7e-48c3-32cb-b552-d9a0482c19c5"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/forms/{form_uuid}/fields/{formField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

formField_uuid   string   

Example: abceea7e-48c3-32cb-b552-d9a0482c19c5

Store

requires authentication

Store a newly created formField.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"molestias\",
    \"input_type\": \"veritatis\",
    \"default_value\": \"consequatur\",
    \"is_required\": true,
    \"is_conditional\": false,
    \"has_help_guide\": true,
    \"conditional_value\": \"repellat\",
    \"help_guide\": \"sunt\",
    \"position\": 14
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'molestias',
            'input_type' => 'veritatis',
            'default_value' => 'consequatur',
            'is_required' => true,
            'is_conditional' => false,
            'has_help_guide' => true,
            'conditional_value' => 'repellat',
            'help_guide' => 'sunt',
            'position' => 14,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "molestias",
    "input_type": "veritatis",
    "default_value": "consequatur",
    "is_required": true,
    "is_conditional": false,
    "has_help_guide": true,
    "conditional_value": "repellat",
    "help_guide": "sunt",
    "position": 14
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/forms/{form_uuid}/fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Body Parameters

label   string   

The label of the form field. Example : "Are you satisfied with the communication from our technician?" Example: molestias

input_type   string   

The label of the form field. Example : "MULTI_SELECT" Example: veritatis

default_value   string  optional  

The label of the form field. Example : "[1,2,3,4,5]" Example: consequatur

is_required   boolean  optional  

The label of the form field. Example : true Example: true

is_conditional   boolean  optional  

The label of the form field. Example : true Example: false

has_help_guide   boolean  optional  

The label of the form field. Example : true Example: true

conditional_value   text  optional  

The label of the form field. Example : {"condition1":"condition"} Example: repellat

help_guide   string  optional  

text The label of the form field. Example : "This a help guide for communication from our technicians." Example: sunt

position   integer  optional  

The position of the form field. Example : 1 Example: 14

Update

requires authentication

Update a formfield.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/7d35e814-04bf-3ac4-9f64-81e6359c2c29" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"nam\",
    \"input_type\": \"non\",
    \"default_value\": \"similique\",
    \"is_required\": false,
    \"is_conditional\": true,
    \"has_help_guide\": true,
    \"conditional_value\": \"adipisci\",
    \"help_guide\": \"autem\",
    \"position\": 8
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/7d35e814-04bf-3ac4-9f64-81e6359c2c29';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'nam',
            'input_type' => 'non',
            'default_value' => 'similique',
            'is_required' => false,
            'is_conditional' => true,
            'has_help_guide' => true,
            'conditional_value' => 'adipisci',
            'help_guide' => 'autem',
            'position' => 8,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/7d35e814-04bf-3ac4-9f64-81e6359c2c29"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "nam",
    "input_type": "non",
    "default_value": "similique",
    "is_required": false,
    "is_conditional": true,
    "has_help_guide": true,
    "conditional_value": "adipisci",
    "help_guide": "autem",
    "position": 8
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/forms/{form_uuid}/fields/{formField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

formField_uuid   string   

Example: 7d35e814-04bf-3ac4-9f64-81e6359c2c29

Body Parameters

label   string   

The label of the form field. Example : "Are you satisfied with the communication from our technician?" Example: nam

input_type   string   

The label of the form field. Example : "MULTI_SELECT" Example: non

default_value   string  optional  

The label of the form field. Example : "[1,2,3,4,5]" Example: similique

is_required   boolean  optional  

The label of the form field. Example : true Example: false

is_conditional   boolean  optional  

The label of the form field. Example : true Example: true

has_help_guide   boolean  optional  

The label of the form field. Example : true Example: true

conditional_value   text  optional  

The label of the form field. Example : {"condition1":"condition"} Example: adipisci

help_guide   string  optional  

text The label of the form field. Example : "This a help guide for communication from our technicians." Example: autem

position   integer  optional  

The position of the form field. Example : 1 Example: 8

Update

requires authentication

Update a formfield.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/9fa5b7d5-9297-30c5-938e-05e4c0b379de" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"voluptatem\",
    \"input_type\": \"enim\",
    \"default_value\": \"id\",
    \"is_required\": true,
    \"is_conditional\": false,
    \"has_help_guide\": false,
    \"conditional_value\": \"dolore\",
    \"help_guide\": \"in\",
    \"position\": 11
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/9fa5b7d5-9297-30c5-938e-05e4c0b379de';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'voluptatem',
            'input_type' => 'enim',
            'default_value' => 'id',
            'is_required' => true,
            'is_conditional' => false,
            'has_help_guide' => false,
            'conditional_value' => 'dolore',
            'help_guide' => 'in',
            'position' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/9fa5b7d5-9297-30c5-938e-05e4c0b379de"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "voluptatem",
    "input_type": "enim",
    "default_value": "id",
    "is_required": true,
    "is_conditional": false,
    "has_help_guide": false,
    "conditional_value": "dolore",
    "help_guide": "in",
    "position": 11
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/forms/{form_uuid}/fields/{formField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

formField_uuid   string   

Example: 9fa5b7d5-9297-30c5-938e-05e4c0b379de

Body Parameters

label   string   

The label of the form field. Example : "Are you satisfied with the communication from our technician?" Example: voluptatem

input_type   string   

The label of the form field. Example : "MULTI_SELECT" Example: enim

default_value   string  optional  

The label of the form field. Example : "[1,2,3,4,5]" Example: id

is_required   boolean  optional  

The label of the form field. Example : true Example: true

is_conditional   boolean  optional  

The label of the form field. Example : true Example: false

has_help_guide   boolean  optional  

The label of the form field. Example : true Example: false

conditional_value   text  optional  

The label of the form field. Example : {"condition1":"condition"} Example: dolore

help_guide   string  optional  

text The label of the form field. Example : "This a help guide for communication from our technicians." Example: in

position   integer  optional  

The position of the form field. Example : 1 Example: 11

Patch

requires authentication

Patch a company form field.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/13c84375-8142-3b82-bb14-22a83a07d7fb" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"tempore\",
    \"input_type\": \"vel\",
    \"default_value\": \"nemo\",
    \"is_required\": false,
    \"is_conditional\": true,
    \"has_help_guide\": true,
    \"conditional_value\": \"rem\",
    \"help_guide\": \"repellendus\",
    \"position\": 6
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/13c84375-8142-3b82-bb14-22a83a07d7fb';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'tempore',
            'input_type' => 'vel',
            'default_value' => 'nemo',
            'is_required' => false,
            'is_conditional' => true,
            'has_help_guide' => true,
            'conditional_value' => 'rem',
            'help_guide' => 'repellendus',
            'position' => 6,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/13c84375-8142-3b82-bb14-22a83a07d7fb"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "tempore",
    "input_type": "vel",
    "default_value": "nemo",
    "is_required": false,
    "is_conditional": true,
    "has_help_guide": true,
    "conditional_value": "rem",
    "help_guide": "repellendus",
    "position": 6
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/forms/{form_uuid}/fields/{formField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

formField_uuid   string   

Example: 13c84375-8142-3b82-bb14-22a83a07d7fb

Body Parameters

label   string  optional  

The label of the form field. Example : "Are you satisfied with the communication from our technician?" Example: tempore

input_type   string  optional  

The label of the form field. Example : "MULTI_SELECT" Example: vel

default_value   string  optional  

The label of the form field. Example : "[1,2,3,4,5]" Example: nemo

is_required   boolean  optional  

The label of the form field. Example : true Example: false

is_conditional   boolean  optional  

The label of the form field. Example : true Example: true

has_help_guide   boolean  optional  

The label of the form field. Example : true Example: true

conditional_value   text  optional  

The label of the form field. Example : {"condition1":"condition"} Example: rem

help_guide   string  optional  

text The label of the form field. Example : "This a help guide for communication from our technicians." Example: repellendus

position   integer  optional  

The position of the form field. Example : 1 Example: 6

Delete

requires authentication

Delete a form field.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/230ed373-48c4-341f-a242-64588dc7d0bb" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/230ed373-48c4-341f-a242-64588dc7d0bb';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/230ed373-48c4-341f-a242-64588dc7d0bb"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/forms/{form_uuid}/fields/{formField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

formField_uuid   string   

Example: 230ed373-48c4-341f-a242-64588dc7d0bb

App Data

API for app data such as: countries, states, roles, statuses, etc.

Application Settings.

requires authentication

Show the list of application data: [roles, company_locations, statuses, countries[states], client_version]

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/app-data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/app-data';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/app-data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/app-data

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Customer Contacts

API for customer contacts

Update

requires authentication

Update customer contacts

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-contacts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contacts[]\": null,
    \"delete_contacts[]\": null
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-contacts';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'contacts[]' => null,
            'delete_contacts[]' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-contacts"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "contacts[]": null,
    "delete_contacts[]": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/customers/{customer_uuid}/customer-contacts

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   string  optional  

uuid required The UUID of the customer that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Body Parameters

contacts[]   string[]  optional  

of contacts.

delete_contacts[]   string[]  optional  

of contacts.uuid to be deleted.

Service Plan Custom Field

API for Service Plan Custom Field

List

requires authentication

Shows the list of Service Plan Custom Fields with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/service-plans/{servicePlan_uuid}/custom-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

page   integer  optional  

The page number. Example : 1 Example: 10

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 1

sort_by   string  optional  

The column name. Example : name Example: inventore

sort_order   string  optional  

The order in which you want your records. Example : asc Example: autem

search   string  optional  

The general search, it will find matching string. Example : home Example: consequatur

Create (Single/Multiple)

requires authentication

Store a newly created Service Plan Custom Field. For multiple creation, the @bodyParameter will be an array of a single @bodyParameter

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"First Name\",
    \"input_type\": \"TEXT\",
    \"default_value\": \"\\\"\\\"\",
    \"combine_input_value_collection\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'First Name',
            'input_type' => 'TEXT',
            'default_value' => '""',
            'combine_input_value_collection' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "First Name",
    "input_type": "TEXT",
    "default_value": "\"\"",
    "combine_input_value_collection": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/service-plans/{servicePlan_uuid}/custom-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Body Parameters

label   string   

The label Service Plan Custom Field. Example: First Name

input_type   string   

The field type of the custom field. Example: TEXT

default_value   string  optional  

optional The default value of the custom field. Example: ""

combine_input_value_collection   boolean  optional  

optional The option to combine custom fields by label. Example: true

Update (Single/Multiple)

requires authentication

Modify the specified Service Plan Custom Field. For Multiple update, @bodyparameter will be an array of the Single @bodyParameter (if uuid is included then perform an update; else, create new record).

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"custom_fields\": \"zulldzjdeejgs\",
    \"save_service_plan_as\": \"SERVICE_PLAN_DRAFT\",
    \"label\": \"First Name\",
    \"input_type\": \"TEXT\",
    \"default_value\": \"\\\"\\\"\",
    \"combine_input_value_collection\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'custom_fields' => 'zulldzjdeejgs',
            'save_service_plan_as' => 'SERVICE_PLAN_DRAFT',
            'label' => 'First Name',
            'input_type' => 'TEXT',
            'default_value' => '""',
            'combine_input_value_collection' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "custom_fields": "zulldzjdeejgs",
    "save_service_plan_as": "SERVICE_PLAN_DRAFT",
    "label": "First Name",
    "input_type": "TEXT",
    "default_value": "\"\"",
    "combine_input_value_collection": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/service-plans/{servicePlan_uuid}/custom-fields

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Body Parameters

custom_fields   string[]  optional  

Must have at least 0 items. Must not have more than 150 items. Example: zulldzjdeejgs
label   string   

Must not be greater than 191 characters. Example: nv

input_type   string  optional  
combine_input_value_collection   boolean  optional  

Example: true

save_service_plan_as   string  optional  

Example: SERVICE_PLAN_DRAFT

Must be one of:
  • SERVICE_PLAN_DRAFT
  • SERVICE_PLAN_ACTIVE
  • SERVICE_PLAN_ARCHIVED
label   string   

The label Service Plan Custom Field. Example: First Name

input_type   string   

The field type of the custom field. Example: TEXT

default_value   string  optional  

optional The default value of the custom field. Example: ""

combine_input_value_collection   boolean  optional  

optional The option to combine custom fields by label. Example: true

Get

requires authentication

Display the specified Service Plan Custom Field.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/8b76ba3f-db31-347e-9ed6-9f2cb85124a3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/8b76ba3f-db31-347e-9ed6-9f2cb85124a3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/8b76ba3f-db31-347e-9ed6-9f2cb85124a3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/service-plans/{servicePlan_uuid}/custom-fields/{servicePlanCustomField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanCustomField_uuid   string   

Example: 8b76ba3f-db31-347e-9ed6-9f2cb85124a3

Update (Single/Multiple)

requires authentication

Modify the specified Service Plan Custom Field. For Multiple update, @bodyparameter will be an array of the Single @bodyParameter (if uuid is included then perform an update; else, create new record).

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/812cf74a-13bc-3b39-bdec-3ca6e026f74f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"custom_fields\": \"ghplxtodhrwbcabnzxfojlvu\",
    \"save_service_plan_as\": \"SERVICE_PLAN_ACTIVE\",
    \"label\": \"First Name\",
    \"input_type\": \"TEXT\",
    \"default_value\": \"\\\"\\\"\",
    \"combine_input_value_collection\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/812cf74a-13bc-3b39-bdec-3ca6e026f74f';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'custom_fields' => 'ghplxtodhrwbcabnzxfojlvu',
            'save_service_plan_as' => 'SERVICE_PLAN_ACTIVE',
            'label' => 'First Name',
            'input_type' => 'TEXT',
            'default_value' => '""',
            'combine_input_value_collection' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/812cf74a-13bc-3b39-bdec-3ca6e026f74f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "custom_fields": "ghplxtodhrwbcabnzxfojlvu",
    "save_service_plan_as": "SERVICE_PLAN_ACTIVE",
    "label": "First Name",
    "input_type": "TEXT",
    "default_value": "\"\"",
    "combine_input_value_collection": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/service-plans/{servicePlan_uuid}/custom-fields/{servicePlanCustomField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanCustomField_uuid   string   

Example: 812cf74a-13bc-3b39-bdec-3ca6e026f74f

Body Parameters

custom_fields   string[]  optional  

Must have at least 0 items. Must not have more than 150 items. Example: ghplxtodhrwbcabnzxfojlvu
label   string   

Must not be greater than 191 characters. Example: g

input_type   string  optional  
combine_input_value_collection   boolean  optional  

Example: true

save_service_plan_as   string  optional  

Example: SERVICE_PLAN_ACTIVE

Must be one of:
  • SERVICE_PLAN_DRAFT
  • SERVICE_PLAN_ACTIVE
  • SERVICE_PLAN_ARCHIVED
label   string   

The label Service Plan Custom Field. Example: First Name

input_type   string   

The field type of the custom field. Example: TEXT

default_value   string  optional  

optional The default value of the custom field. Example: ""

combine_input_value_collection   boolean  optional  

optional The option to combine custom fields by label. Example: true

Patch

requires authentication

Perform patches for the specified Service Plan Custom Field.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/d599e957-9cc8-3609-b597-4850205f3ed8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"First Name\",
    \"input_type\": \"TEXT\",
    \"default_value\": \"\\\"\\\"\",
    \"combine_input_value_collection\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/d599e957-9cc8-3609-b597-4850205f3ed8';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'First Name',
            'input_type' => 'TEXT',
            'default_value' => '""',
            'combine_input_value_collection' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/d599e957-9cc8-3609-b597-4850205f3ed8"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "label": "First Name",
    "input_type": "TEXT",
    "default_value": "\"\"",
    "combine_input_value_collection": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}/custom-fields/{servicePlanCustomField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanCustomField_uuid   string   

Example: d599e957-9cc8-3609-b597-4850205f3ed8

Body Parameters

label   string  optional  

The label Service Plan Custom Field. Example: First Name

input_type   string  optional  

The field type of the custom field. Example: TEXT

default_value   string  optional  

optional The default value of the custom field. Example: ""

combine_input_value_collection   boolean  optional  

optional The option to combine custom fields by label. Example: true

Delete

requires authentication

Remove the specified Service Plan Custom Field.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/d347f941-a005-3a41-8f70-40b435765156" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/d347f941-a005-3a41-8f70-40b435765156';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/custom-fields/d347f941-a005-3a41-8f70-40b435765156"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/service-plans/{servicePlan_uuid}/custom-fields/{servicePlanCustomField_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanCustomField_uuid   string   

Example: d347f941-a005-3a41-8f70-40b435765156

Media Tag

API for Media Tag

List

requires authentication

Shows the list of media tag with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-tags';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/media-tags

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 2

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 16

sort_by   string  optional  

The column name. Example : name Example: qui

sort_order   string  optional  

The order in which you want your records. Example : asc Example: nesciunt

search   string  optional  

The general search, it will find matching string. Example : home Example: dolorem

Show

requires authentication

Show a single media tag

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-tags/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-tags/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/media-tags/{mediaTag_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaTag_uuid   integer   

Example: 1

Store

requires authentication

Upload a media tag

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/media-tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"eaque\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-tags';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'eaque',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "eaque"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/media-tags

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

The name of the file. Example : Tag 1 Example: eaque

Update

requires authentication

Update a media tag.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/media-tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nisi\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-tags/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'nisi',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-tags/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "nisi"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/media-tags/{mediaTag_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaTag_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media tag. Example : "My media tag" Example: nisi

Patch

requires authentication

Patch a media tag.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/media-tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"magnam\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-tags/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'magnam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-tags/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "magnam"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/media-tags/{mediaTag_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaTag_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media tag. Example : "My media tag" Example: magnam

Delete

requires authentication

Delete a media tag.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/media-tags/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-tags/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-tags/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/media-tags/{mediaTag_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaTag_uuid   integer   

Example: 1

Property Locations

API for Property Locations

List

requires authentication

Shows the list of property locations with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/property-locations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/property-locations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/property-locations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 18

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 11

sort_by   string  optional  

The column name. Example : name Example: nulla

sort_order   string  optional  

The order in which you want your records. Example : asc Example: voluptatum

search   string  optional  

The general search, it will find matching string. Example : home Example: iure

Show

requires authentication

Show a single property location.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/property-locations/{propertyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

propertyLocation_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created property location.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"explicabo\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/property-locations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'explicabo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "explicabo"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/property-locations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the property location. Example : "Living Room" Example: explicabo

Update

requires authentication

Update a property location.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"omnis\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'omnis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "omnis"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/property-locations/{propertyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

propertyLocation_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the property location. Example : "Living Room Updated" Example: omnis

Patch

requires authentication

Patch a company property location.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptatum\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptatum',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptatum"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/property-locations/{propertyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

propertyLocation_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the property location. Example : "Living Room Patched" Example: voluptatum

Delete

requires authentication

Delete a property location.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/property-locations/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/property-locations/{propertyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

propertyLocation_uuid   integer   

Example: 1

State

API for state details

List / Fetch

Shows the list of state or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/countries/1b5b40c6-7ade-3ccb-8ba9-96b5f2c61cb4/states/992613b4-65a7-37fb-bc52-4cbbb365e7fe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"country_state_uuid\": \"ed20f1c0-2749-11ec-85fa-a791bcbdc50d\",
    \"name\": \"Queen Creek\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/countries/1b5b40c6-7ade-3ccb-8ba9-96b5f2c61cb4/states/992613b4-65a7-37fb-bc52-4cbbb365e7fe';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'country_state_uuid' => 'ed20f1c0-2749-11ec-85fa-a791bcbdc50d',
            'name' => 'Queen Creek',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/countries/1b5b40c6-7ade-3ccb-8ba9-96b5f2c61cb4/states/992613b4-65a7-37fb-bc52-4cbbb365e7fe"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "country_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "country_state_uuid": "ed20f1c0-2749-11ec-85fa-a791bcbdc50d",
    "name": "Queen Creek"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/countries/{countryUuid}/states/{countryStateUuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

countryUuid   string   

Example: 1b5b40c6-7ade-3ccb-8ba9-96b5f2c61cb4

countryStateUuid   string   

Example: 992613b4-65a7-37fb-bc52-4cbbb365e7fe

Body Parameters

country_uuid   string  optional  

optional The country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_state_uuid   string  optional  

optional The state uuid. Example: ed20f1c0-2749-11ec-85fa-a791bcbdc50d

name   string  optional  

optional The state name. Example: Queen Creek

Company Tax

API for Company Tax

List

requires authentication

Shows the list of taxes with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/taxes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/taxes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 16

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 19

sort_by   string  optional  

The column name. Example : name Example: sit

sort_order   string  optional  

The order in which you want your records. Example : asc Example: repellat

search   string  optional  

The general search, it will find matching string (name, postal_code, cities). Example : home Example: laborum

country_uuid   string  optional  

The UUID of country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 51277d46-c742-332a-969c-9a4cb4637583

country_state_uuids   integer  optional  

string[] The UUID of country state. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 3

is_compound   string  optional  

boolean To filter by is_compound flag. Example : true Example: eligendi

Patch Index

requires authentication

Performs specific updates for tax settings

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/taxes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

tax_ranking_list   string  optional  

string[] A dictionary of uuids with uuid as key and rank as the value. Example : {"69e56cdf-cea8-4356-b35d-58d610aba886" : 1, "9c578b77-916a-4620-a246-fa951f422912" : 2} Example: est

Show

requires authentication

Show a single tax.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/taxes/bb85b494-12f7-33d7-a37c-aaf3337b0bad" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes/bb85b494-12f7-33d7-a37c-aaf3337b0bad';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/bb85b494-12f7-33d7-a37c-aaf3337b0bad"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/taxes/{companyTax_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyTax_uuid   string   

Example: bb85b494-12f7-33d7-a37c-aaf3337b0bad

Store

requires authentication

Store a newly created tax.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"0a979a14-978d-314a-bb3a-3f8dd443ed98\",
    \"country_state_uuids\": [
        \"et\"
    ],
    \"name\": \"ipsam\",
    \"postal_codes\": 85410,
    \"cities\": \"Queen Creek\",
    \"rate\": \"12.0000\",
    \"is_compound\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => '0a979a14-978d-314a-bb3a-3f8dd443ed98',
            'country_state_uuids' => [
                'et',
            ],
            'name' => 'ipsam',
            'postal_codes' => 85410,
            'cities' => 'Queen Creek',
            'rate' => '12.0000',
            'is_compound' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "country_uuid": "0a979a14-978d-314a-bb3a-3f8dd443ed98",
    "country_state_uuids": [
        "et"
    ],
    "name": "ipsam",
    "postal_codes": 85410,
    "cities": "Queen Creek",
    "rate": "12.0000",
    "is_compound": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/taxes

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

country_uuid   string   

The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0a979a14-978d-314a-bb3a-3f8dd443ed98

country_state_uuids   string[]   

An array of country state UUID. Example : ["815d3d9c-f371-3781-8456-7e6954b5b0f5", "815d3d9c-f371-3781-8456-7e6954b5b0f2"]

name   string   

The name of the tax. Example : Pest Route Initial Proposal Example: ipsam

postal_codes   string[]  optional  

optional The postal code of the company. Example: 85410

cities   string  optional  

required[] The company city name. Example: Queen Creek

rate   decimal   

The tax rate. Example: 12.0000

is_compound   boolean   

A flag that indicate if the tax is a compound. Example: true

Update

requires authentication

Update a tax.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/f8a4402f-33d0-3f9c-ace3-89fdec833134" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"ca45c197-d553-3faa-aee6-0d5b027899c2\",
    \"country_state_uuids\": [
        \"repudiandae\"
    ],
    \"name\": \"autem\",
    \"postal_codes\": \"85410\",
    \"cities\": \"Queen Creek\",
    \"rate\": \"12.0000\",
    \"is_compound\": true,
    \"rank\": 1
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes/f8a4402f-33d0-3f9c-ace3-89fdec833134';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => 'ca45c197-d553-3faa-aee6-0d5b027899c2',
            'country_state_uuids' => [
                'repudiandae',
            ],
            'name' => 'autem',
            'postal_codes' => '85410',
            'cities' => 'Queen Creek',
            'rate' => '12.0000',
            'is_compound' => true,
            'rank' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/f8a4402f-33d0-3f9c-ace3-89fdec833134"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "country_uuid": "ca45c197-d553-3faa-aee6-0d5b027899c2",
    "country_state_uuids": [
        "repudiandae"
    ],
    "name": "autem",
    "postal_codes": "85410",
    "cities": "Queen Creek",
    "rate": "12.0000",
    "is_compound": true,
    "rank": 1
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/taxes/{companyTax_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyTax_uuid   string   

Example: f8a4402f-33d0-3f9c-ace3-89fdec833134

Body Parameters

country_uuid   string   

The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: ca45c197-d553-3faa-aee6-0d5b027899c2

country_state_uuids   string[]   

The UUID of a country state. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5"

name   string   

The name of the tax. Example : Pest Route Initial Proposal Example: autem

postal_codes   string  optional  

optional The postal code of the company. Example: 85410

cities   string   

The company city name. Example: Queen Creek

rate   decimal   

The tax rate. Example: 12.0000

is_compound   boolean   

A flag that indicate if the tax is a compound. Example: true

rank   integer  optional  

The rank/order number of tax in a company. Example: 1

Patch

requires authentication

Patch a tax.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/41e0a37c-c545-3dff-a00f-5781fbbaad47" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"f67b0bd4-14d0-3c40-979b-7cd87542d8c5\",
    \"country_state_uuids\": [
        \"aperiam\"
    ],
    \"name\": \"rerum\",
    \"postal_codes\": \"85410\",
    \"cities\": \"Queen Creek\",
    \"rate\": \"12.0000\",
    \"is_compound\": true,
    \"rank\": 1
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes/41e0a37c-c545-3dff-a00f-5781fbbaad47';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => 'f67b0bd4-14d0-3c40-979b-7cd87542d8c5',
            'country_state_uuids' => [
                'aperiam',
            ],
            'name' => 'rerum',
            'postal_codes' => '85410',
            'cities' => 'Queen Creek',
            'rate' => '12.0000',
            'is_compound' => true,
            'rank' => 1,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/41e0a37c-c545-3dff-a00f-5781fbbaad47"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "country_uuid": "f67b0bd4-14d0-3c40-979b-7cd87542d8c5",
    "country_state_uuids": [
        "aperiam"
    ],
    "name": "rerum",
    "postal_codes": "85410",
    "cities": "Queen Creek",
    "rate": "12.0000",
    "is_compound": true,
    "rank": 1
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/taxes/{companyTax_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyTax_uuid   string   

Example: 41e0a37c-c545-3dff-a00f-5781fbbaad47

Body Parameters

country_uuid   string  optional  

optional The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: f67b0bd4-14d0-3c40-979b-7cd87542d8c5

country_state_uuids   string[]  optional  

optional The UUID of a country state. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5"

name   string  optional  

optional The name of the tax. Example : Pest Route Initial Proposal Example: rerum

postal_codes   string  optional  

optional The postal code of the company. Example: 85410

cities   string  optional  

optional The company city name. Example: Queen Creek

rate   decimal  optional  

optional The tax rate. Example: 12.0000

is_compound   boolean  optional  

optional A flag that indicate if the tax is a compound. Example: true

rank   integer  optional  

The rank/order number of tax in a company. Example: 1

Delete

requires authentication

Delete a tax.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/4cbe1efa-e193-3969-be31-5badcfab18df" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/taxes/4cbe1efa-e193-3969-be31-5badcfab18df';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/taxes/4cbe1efa-e193-3969-be31-5badcfab18df"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/taxes/{companyTax_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyTax_uuid   string   

Example: 4cbe1efa-e193-3969-be31-5badcfab18df

Company Location

API for company locations

List

requires authentication

Shows the list of locations with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/locations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/locations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 3

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 4

sort_by   string  optional  

The column name. Example : name Example: eum

sort_order   string  optional  

The order in which you want your records. Example : asc Example: ex

search   string  optional  

The general search, it will find matching string. Example : home Example: perspiciatis

has_service_plans   string  optional  

boolean The locations which has service plans. Example : true Example: ut

Show

requires authentication

Shows the detail of a specific company location.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/locations/2eabb976-1d82-39dc-8cd2-45b834117af1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"withTemplates\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations/2eabb976-1d82-39dc-8cd2-45b834117af1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'withTemplates' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/2eabb976-1d82-39dc-8cd2-45b834117af1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "withTemplates": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/locations/{companyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocation_uuid   string   

Example: 2eabb976-1d82-39dc-8cd2-45b834117af1

companyUUID   string   

The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyLocationUUID   string   

The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

withTemplates   boolean  optional  

optional Whether return templates attached to company location. Example: true

Create

requires authentication

This endpoint lets user to create single record using uuid.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/locations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Phoenix Metro Area\",
    \"description\": \"We do amazing things here.\",
    \"phone\": \"5554443333\",
    \"email\": \"hello@smarterlaunch.com\",
    \"address1\": \"\'123 Smarter Launch Way\'\",
    \"address2\": \"\'Suite 101\'\",
    \"city\": \"Queen Creek\",
    \"country_state_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"country_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"postal_code\": \"85410\",
    \"latitude\": \"23.0396\",
    \"longitude\": \"72.566\",
    \"enable_overrides\": true,
    \"license_number\": \"lc-123456\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Phoenix Metro Area',
            'description' => 'We do amazing things here.',
            'phone' => '5554443333',
            'email' => 'hello@smarterlaunch.com',
            'address1' => '\'123 Smarter Launch Way\'',
            'address2' => '\'Suite 101\'',
            'city' => 'Queen Creek',
            'country_state_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'country_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'postal_code' => '85410',
            'latitude' => '23.0396',
            'longitude' => '72.566',
            'enable_overrides' => true,
            'license_number' => 'lc-123456',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Phoenix Metro Area",
    "description": "We do amazing things here.",
    "phone": "5554443333",
    "email": "hello@smarterlaunch.com",
    "address1": "'123 Smarter Launch Way'",
    "address2": "'Suite 101'",
    "city": "Queen Creek",
    "country_state_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "country_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "postal_code": "85410",
    "latitude": "23.0396",
    "longitude": "72.566",
    "enable_overrides": true,
    "license_number": "lc-123456"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/locations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the location. Example: Phoenix Metro Area

description   string  optional  

optional The description of the location. Example: We do amazing things here.

phone   string  optional  

optional The last name of the location. Example: 5554443333

email   string  optional  

optional The email of the location. Example: hello@smarterlaunch.com

address1   string  optional  

optional The address of the company. Example: '123 Smarter Launch Way'

address2   string  optional  

optional The address of the company. Example: 'Suite 101'

city   string  optional  

optional The company city name. Example: Queen Creek

country_state_uuid   string  optional  

optional The company state uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_uuid   string  optional  

optional The company country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

postal_code   string  optional  

optional The postal code of the company. Example: 85410

latitude   string  optional  

optional The latitude of the company. Example: 23.0396

longitude   string  optional  

optional The longitude of the company. Example: 72.566

enable_overrides   boolean  optional  

optional. Example: true

license_number   string  optional  

optional. Example: lc-123456

Update All

requires authentication

This endpoint lets user to update multiple record using uuids.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/updateAll" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations/updateAll';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/updateAll"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/locations/updateAll

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyUuid   string   

The uuid id of the company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

*   object  optional  
name   string   

The name of the location. Example: Phoenix Metro Area

description   string  optional  

optional The description of the location. Example: We do amazing things here.

phone   string  optional  

optional The last name of the location. Example: 5554443333

email   string  optional  

optional The email of the location. Example: hello@smarterlaunch.com

address1   string  optional  

optional The address of the company. Example: '123 Smarter Launch Way'

address2   string  optional  

optional The address of the company. Example: 'Suite 101'

city   string  optional  

optional The company city name. Example: Queen Creek

country_state_uuid   string  optional  

optional The company state uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_uuid   string  optional  

optional The company country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

postal_code   string  optional  

optional The postal code of the company. Example: 85410

latitude   string  optional  

optional The latitude of the company. Example: 23.0396

longitude   string  optional  

optional The longitude of the company. Example: 72.566

enable_overrides   boolean  optional  

optional. Example: true

Edit

requires authentication

This endpoint lets user to update single record using uuid (using PUT method).

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/fdc3ed75-3729-3477-9e87-58f878a464d6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Phoenix Metro Area\",
    \"description\": \"We do amazing things here.\",
    \"phone\": \"5554443333\",
    \"email\": \"hello@smarterlaunch.com\",
    \"address1\": \"\'123 Smarter Launch Way\'\",
    \"address2\": \"\'Suite 101\'\",
    \"city\": \"Queen Creek\",
    \"country_state_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"country_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"postal_code\": \"85410\",
    \"latitude\": \"23.0396\",
    \"longitude\": \"72.566\",
    \"enable_overrides\": true,
    \"license_number\": \"lc-123456\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations/fdc3ed75-3729-3477-9e87-58f878a464d6';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Phoenix Metro Area',
            'description' => 'We do amazing things here.',
            'phone' => '5554443333',
            'email' => 'hello@smarterlaunch.com',
            'address1' => '\'123 Smarter Launch Way\'',
            'address2' => '\'Suite 101\'',
            'city' => 'Queen Creek',
            'country_state_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'country_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'postal_code' => '85410',
            'latitude' => '23.0396',
            'longitude' => '72.566',
            'enable_overrides' => true,
            'license_number' => 'lc-123456',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/fdc3ed75-3729-3477-9e87-58f878a464d6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Phoenix Metro Area",
    "description": "We do amazing things here.",
    "phone": "5554443333",
    "email": "hello@smarterlaunch.com",
    "address1": "'123 Smarter Launch Way'",
    "address2": "'Suite 101'",
    "city": "Queen Creek",
    "country_state_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "country_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "postal_code": "85410",
    "latitude": "23.0396",
    "longitude": "72.566",
    "enable_overrides": true,
    "license_number": "lc-123456"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/locations/{companyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocation_uuid   string   

Example: fdc3ed75-3729-3477-9e87-58f878a464d6

companyUuid   string   

The uuid id of the company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyLocationUuid   string   

The uuid id of the location. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the location. Example: Phoenix Metro Area

description   string  optional  

optional The description of the location. Example: We do amazing things here.

phone   string  optional  

optional The last name of the location. Example: 5554443333

email   string  optional  

optional The email of the location. Example: hello@smarterlaunch.com

address1   string  optional  

optional The address of the company. Example: '123 Smarter Launch Way'

address2   string  optional  

optional The address of the company. Example: 'Suite 101'

city   string  optional  

optional The company city name. Example: Queen Creek

country_state_uuid   string  optional  

optional The company state uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_uuid   string  optional  

optional The company country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

postal_code   string  optional  

optional The postal code of the company. Example: 85410

latitude   string  optional  

optional The latitude of the company. Example: 23.0396

longitude   string  optional  

optional The longitude of the company. Example: 72.566

enable_overrides   boolean  optional  

optional. Example: true

license_number   string  optional  

optional. Example: lc-123456

Update

requires authentication

This endpoint lets user to update single record using uuid.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/6bc8a9f5-a8b5-39f6-bc10-5a0af734482d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Phoenix Metro Area\",
    \"description\": \"We do amazing things here.\",
    \"phone\": \"5554443333\",
    \"email\": \"hello@smarterlaunch.com\",
    \"address1\": \"\'123 Smarter Launch Way\'\",
    \"address2\": \"\'Suite 101\'\",
    \"city\": \"Queen Creek\",
    \"country_state_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"country_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"postal_code\": \"85410\",
    \"latitude\": \"23.0396\",
    \"longitude\": \"72.566\",
    \"enable_overrides\": true,
    \"license_number\": \"lc-123456\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations/6bc8a9f5-a8b5-39f6-bc10-5a0af734482d';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Phoenix Metro Area',
            'description' => 'We do amazing things here.',
            'phone' => '5554443333',
            'email' => 'hello@smarterlaunch.com',
            'address1' => '\'123 Smarter Launch Way\'',
            'address2' => '\'Suite 101\'',
            'city' => 'Queen Creek',
            'country_state_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'country_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'postal_code' => '85410',
            'latitude' => '23.0396',
            'longitude' => '72.566',
            'enable_overrides' => true,
            'license_number' => 'lc-123456',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/6bc8a9f5-a8b5-39f6-bc10-5a0af734482d"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Phoenix Metro Area",
    "description": "We do amazing things here.",
    "phone": "5554443333",
    "email": "hello@smarterlaunch.com",
    "address1": "'123 Smarter Launch Way'",
    "address2": "'Suite 101'",
    "city": "Queen Creek",
    "country_state_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "country_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "postal_code": "85410",
    "latitude": "23.0396",
    "longitude": "72.566",
    "enable_overrides": true,
    "license_number": "lc-123456"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/locations/{companyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocation_uuid   string   

Example: 6bc8a9f5-a8b5-39f6-bc10-5a0af734482d

companyUuid   string   

The uuid id of the company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyLocationUuid   string   

The uuid id of the location. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the location. Example: Phoenix Metro Area

description   string  optional  

optional The description of the location. Example: We do amazing things here.

phone   string  optional  

optional The last name of the location. Example: 5554443333

email   string  optional  

optional The email of the location. Example: hello@smarterlaunch.com

address1   string  optional  

optional The address of the company. Example: '123 Smarter Launch Way'

address2   string  optional  

optional The address of the company. Example: 'Suite 101'

city   string  optional  

optional The company city name. Example: Queen Creek

country_state_uuid   string  optional  

optional The company state uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_uuid   string  optional  

optional The company country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

postal_code   string  optional  

optional The postal code of the company. Example: 85410

latitude   string  optional  

optional The latitude of the company. Example: 23.0396

longitude   string  optional  

optional The longitude of the company. Example: 72.566

enable_overrides   boolean  optional  

optional. Example: true

license_number   string  optional  

optional. Example: lc-123456

Delete

requires authentication

This endpoint enables user to delete a company location

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/5617ca4e-a8ba-38aa-a3ed-63b05fec9825" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations/5617ca4e-a8ba-38aa-a3ed-63b05fec9825';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/5617ca4e-a8ba-38aa-a3ed-63b05fec9825"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/locations/{companyLocation_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocation_uuid   string   

Example: 5617ca4e-a8ba-38aa-a3ed-63b05fec9825

uuid   string   

The uuid of the company location. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Integration Data

requires authentication

Get data from a 3rd party API

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/locations/a7b4d018-4bd3-3eb3-9a80-cf61fc718dde/integration-data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/locations/a7b4d018-4bd3-3eb3-9a80-cf61fc718dde/integration-data';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/locations/a7b4d018-4bd3-3eb3-9a80-cf61fc718dde/integration-data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/locations/{companyLocation_uuid}/integration-data

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocation_uuid   string   

Example: a7b4d018-4bd3-3eb3-9a80-cf61fc718dde

uuid   string   

The uuid of the company location. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

integration_type_uuid   string   

The uuid of the integration type. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

force_look_up   string  optional  

Example: true

User Authentication

API for user authentication

Company Registration.

This endpoint lets company owner/manager to register.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_name\": \"Smarter Launch\",
    \"first_name\": \"John\",
    \"last_name\": \"Smith\",
    \"email\": \"hello@smarterlaunch.com\",
    \"password\": \"$m@4T34L@un(}{\",
    \"confirm_password\": \"$m@4T34L@un(}{\",
    \"referral_source\": \"google ad\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/register';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_name' => 'Smarter Launch',
            'first_name' => 'John',
            'last_name' => 'Smith',
            'email' => 'hello@smarterlaunch.com',
            'password' => '$m@4T34L@un(}{',
            'confirm_password' => '$m@4T34L@un(}{',
            'referral_source' => 'google ad',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/register"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_name": "Smarter Launch",
    "first_name": "John",
    "last_name": "Smith",
    "email": "hello@smarterlaunch.com",
    "password": "$m@4T34L@un(}{",
    "confirm_password": "$m@4T34L@un(}{",
    "referral_source": "google ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/register

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

company_name   string   

The company name of the user. Example: Smarter Launch

first_name   string   

The first name of the user. Example: John

last_name   string   

The last name of the user. Example: Smith

email   string   

The email of the user. Example: hello@smarterlaunch.com

password   string   

The password of the user. Example: $m@4T34L@un(}{

confirm_password   string   

The same password for confirmation. Example: $m@4T34L@un(}{

referral_source   string  optional  

optional The referral source. Example: google ad

Company registration using social account.

This endpoint lets company to register using social account.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/register/social" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"social_type\": 1,
    \"code\": \"111806022046983237516\",
    \"referral_source\": \"google ad\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/register/social';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'social_type' => 1,
            'code' => '111806022046983237516',
            'referral_source' => 'google ad',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/register/social"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "social_type": 1,
    "code": "111806022046983237516",
    "referral_source": "google ad"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/register/social

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

social_type   integer   

The login type of the user (Google = 1). Example: 1

code   string   

auth code of the user. Example: 111806022046983237516

referral_source   string  optional  

optional The referral source. Example: google ad

User registration based on company invite.

This endpoint lets you user to register himself who are invited by company.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/register/company-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Smith\",
    \"email\": \"hello@smarterlaunch.com\",
    \"password\": \"$m@4T34L@un(}{\",
    \"confirm_password\": \"$m@4T34L@un(}{\",
    \"token\": \"7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/register/company-user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'first_name' => 'John',
            'last_name' => 'Smith',
            'email' => 'hello@smarterlaunch.com',
            'password' => '$m@4T34L@un(}{',
            'confirm_password' => '$m@4T34L@un(}{',
            'token' => '7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/register/company-user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "last_name": "Smith",
    "email": "hello@smarterlaunch.com",
    "password": "$m@4T34L@un(}{",
    "confirm_password": "$m@4T34L@un(}{",
    "token": "7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/register/company-user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

first_name   string   

The first name of the user. Example: John

last_name   string   

The last name of the user. Example: Smith

email   string   

The email of the user. Example: hello@smarterlaunch.com

password   string   

The password of the user. Example: $m@4T34L@un(}{

confirm_password   string   

The same password for confirmation. Example: $m@4T34L@un(}{

token   string   

To restrict unauthorized registration. Example: 7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE

User registration using social account based on company invite.

This endpoint lets user to register using social account.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/register/social/company-user" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"hello@smarterlaunch.com\",
    \"social_type\": 1,
    \"social_id\": \"111806022046983237516\",
    \"social_token_id\": \"eyRhbGciOiJSUzI1NiIsImtpZCI6Ijg1ODI4YzU5Jjg0YTY5YjU0YjI3NDgzZTQ4N2MzYmQ0NmNkMmEyYjMiLCJ0eXAiOiJKV1QifB\",
    \"token\": \"7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/register/social/company-user';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'hello@smarterlaunch.com',
            'social_type' => 1,
            'social_id' => '111806022046983237516',
            'social_token_id' => 'eyRhbGciOiJSUzI1NiIsImtpZCI6Ijg1ODI4YzU5Jjg0YTY5YjU0YjI3NDgzZTQ4N2MzYmQ0NmNkMmEyYjMiLCJ0eXAiOiJKV1QifB',
            'token' => '7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/register/social/company-user"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "hello@smarterlaunch.com",
    "social_type": 1,
    "social_id": "111806022046983237516",
    "social_token_id": "eyRhbGciOiJSUzI1NiIsImtpZCI6Ijg1ODI4YzU5Jjg0YTY5YjU0YjI3NDgzZTQ4N2MzYmQ0NmNkMmEyYjMiLCJ0eXAiOiJKV1QifB",
    "token": "7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/register/social/company-user

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: hello@smarterlaunch.com

social_type   integer   

The login type of the user (Google = 1). Example: 1

social_id   string   

The social id of the user provided by the 3rd party provider. Example: 111806022046983237516

social_token_id   string   

The social id of the user. Example: eyRhbGciOiJSUzI1NiIsImtpZCI6Ijg1ODI4YzU5Jjg0YTY5YjU0YjI3NDgzZTQ4N2MzYmQ0NmNkMmEyYjMiLCJ0eXAiOiJKV1QifB

token   string   

To restrict unauthorized registration. Example: 7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE

Login.

This endpoint allows common login into the system.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"hello@smarterlaunch.com\",
    \"password\": \"xxxxxx\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/login';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'hello@smarterlaunch.com',
            'password' => 'xxxxxx',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/login"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "hello@smarterlaunch.com",
    "password": "xxxxxx"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/login

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email-id of the user. Example: hello@smarterlaunch.com

password   string   

The password of the user. Example: xxxxxx

Social Login.

This endpoint lets you login into the system using a 3rd party provider.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/login/social" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"social_type\": 1,
    \"code\": \"111806022046983237516\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/login/social';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'social_type' => 1,
            'code' => '111806022046983237516',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/login/social"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "social_type": 1,
    "code": "111806022046983237516"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/login/social

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

social_type   integer   

The login type of the user (Google = 1). Example: 1

code   string   

auth code of the user. Example: 111806022046983237516

Forgot password.

This endpoint lets user to get token to change password.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/forgot-password" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"hello@smarterlaunch.com\",
    \"token\": \"laboriosam\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/forgot-password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'hello@smarterlaunch.com',
            'token' => 'laboriosam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/forgot-password"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "hello@smarterlaunch.com",
    "token": "laboriosam"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/forgot-password

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: hello@smarterlaunch.com

token   string  optional  

This field is required when email is not present. Example: laboriosam

Validate Bearer token.

This endpoint lets user to validate token, on success returns token object.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/token-validate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"bearer_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/token-validate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'bearer_token' => 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/token-validate"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "bearer_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/token-validate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

bearer_token   string  optional  

required. Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...

Get Token Expiration This endpoint allows client to retrieve their user token expiration date.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/auth/token-expiration" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"hello@smarterlaunch.com\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/token-expiration';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'hello@smarterlaunch.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/token-expiration"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "hello@smarterlaunch.com"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/auth/token-expiration

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: hello@smarterlaunch.com

Verify email.

This endpoint lets the user verify their email and login with token and password.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/verify-email" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"hello@smarterlaunch.com\",
    \"password\": \"$m@4T34L@un(}{\",
    \"token\": \"123456\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/verify-email';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'email' => 'hello@smarterlaunch.com',
            'password' => '$m@4T34L@un(}{',
            'token' => '123456',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/verify-email"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "hello@smarterlaunch.com",
    "password": "$m@4T34L@un(}{",
    "token": "123456"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/verify-email

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

email   string   

The email of the user. Example: hello@smarterlaunch.com

password   string   

The password of the user. Example: $m@4T34L@un(}{

token   string   

To restrict unauthorized registration. Example: 123456

Resend the email verification notification.

requires authentication

This endpoint lets user to resend email verification notification.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/verify-email-resend" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/verify-email-resend';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/verify-email-resend"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/auth/verify-email-resend

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Reset password.

requires authentication

This endpoint lets the user reset their password.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/reset-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"$m@4T34L@un(}{\",
    \"confirm_password\": \"$m@4T34L@un(}{\",
    \"token\": \"7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE\",
    \"email\": \"hello@smarterlaunch.com\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/reset-password';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'password' => '$m@4T34L@un(}{',
            'confirm_password' => '$m@4T34L@un(}{',
            'token' => '7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE',
            'email' => 'hello@smarterlaunch.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/reset-password"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "password": "$m@4T34L@un(}{",
    "confirm_password": "$m@4T34L@un(}{",
    "token": "7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE",
    "email": "hello@smarterlaunch.com"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/reset-password

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

password   string   

The password of the user. Example: $m@4T34L@un(}{

confirm_password   string   

The same password for confirmation. Example: $m@4T34L@un(}{

token   string   

To restrict unauthorized registration. Example: 7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE

email   string   

The email of the user. Example: hello@smarterlaunch.com

Check token validity.

requires authentication

This endpoint verifies the validity of a reset password token.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/check-token-validity" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/check-token-validity';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'token' => '7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/check-token-validity"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/check-token-validity

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

The token to be verified. Example: 7hKxKlz5sKHlqXFkkCfsKpj9iVPoaSlM18Uv5JuehYXQfTme33XtxGmNQ1yE

Get invited user by token

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/auth/user-invite" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"BMj4tHdI9jeRidv8O6emwqwepk34sl2tYrm1gakhDhqgOxdi7JO4BEkJG4yh\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/user-invite';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'token' => 'BMj4tHdI9jeRidv8O6emwqwepk34sl2tYrm1gakhDhqgOxdi7JO4BEkJG4yh',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/user-invite"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "token": "BMj4tHdI9jeRidv8O6emwqwepk34sl2tYrm1gakhDhqgOxdi7JO4BEkJG4yh"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/auth/user-invite

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

token   string   

The token provided for the invited user. Example: BMj4tHdI9jeRidv8O6emwqwepk34sl2tYrm1gakhDhqgOxdi7JO4BEkJG4yh

Logout.

requires authentication

let's user to logout.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/logout';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/logout"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/auth/logout

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

User Device Management.

requires authentication

This endpoint lets user to add device information.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/device-info/store" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pushtoken\": \"xxxxx\",
    \"device_name\": \"iPhone 12\",
    \"device_id\": \"skdlfsk-sfs-dsfsdf-sdfs\",
    \"app_version\": \"v1\",
    \"os_version\": \"iOS 14.1\",
    \"time_zone\": \"NZ\",
    \"platform\": \"Apple\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/device-info/store';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pushtoken' => 'xxxxx',
            'device_name' => 'iPhone 12',
            'device_id' => 'skdlfsk-sfs-dsfsdf-sdfs',
            'app_version' => 'v1',
            'os_version' => 'iOS 14.1',
            'time_zone' => 'NZ',
            'platform' => 'Apple',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/device-info/store"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pushtoken": "xxxxx",
    "device_name": "iPhone 12",
    "device_id": "skdlfsk-sfs-dsfsdf-sdfs",
    "app_version": "v1",
    "os_version": "iOS 14.1",
    "time_zone": "NZ",
    "platform": "Apple"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/device-info/store

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

pushtoken   string   

The push-token. Example: xxxxx

device_name   string   

The device name of the device. Example: iPhone 12

device_id   string   

The device id of the device. Example: skdlfsk-sfs-dsfsdf-sdfs

app_version   string   

The app version of the device. Example: v1

os_version   string   

The os version of the device. Example: iOS 14.1

time_zone   string   

The time zone of the user. Example: NZ

platform   string   

The platform of the device. Example: Apple

Company Integration

API for Company Integration

Generic handler for company integration actions

requires authentication

If the method exists within the CompanyIntegrationController, it will be called, otherwise it will be passed to the integration type if the method exists there.

If the endpoint is a no-auth endpoint, we will allow it to be executed without going through the auth middleware. This is useful for endpoints that are called by customers that aren't logged in. The endpoint must be explicitly defined to be a no-auth endpoint in the integration type.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/integrations/56758355-dd73-3691-8378-b5c41e03d90c/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/56758355-dd73-3691-8378-b5c41e03d90c/aut';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/56758355-dd73-3691-8378-b5c41e03d90c/aut"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}/{action}

POST api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}/{action}

PUT api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}/{action}

PATCH api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}/{action}

DELETE api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}/{action}

OPTIONS api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}/{action}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyIntegration_uuid   string   

Example: 56758355-dd73-3691-8378-b5c41e03d90c

action   string   

Example: aut

Generic handler for integration type actions

requires authentication

it will be passed to the integration type if the method exists there.

If the endpoint is a no-auth endpoint, we will allow it to be executed without going through the auth middleware. This is useful for endpoints that are called by customers that aren't logged in. The endpoint must be explicitly defined to be a no-auth endpoint in the integration type.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/integration-types/1/suscipit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/integration-types/1/suscipit';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/integration-types/1/suscipit"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/integration-types/{integrationType_type_code}/{action}

POST api/v1/integration-types/{integrationType_type_code}/{action}

PUT api/v1/integration-types/{integrationType_type_code}/{action}

PATCH api/v1/integration-types/{integrationType_type_code}/{action}

DELETE api/v1/integration-types/{integrationType_type_code}/{action}

OPTIONS api/v1/integration-types/{integrationType_type_code}/{action}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

integrationType_type_code   integer   

Example: 1

action   string   

Example: suscipit

List

requires authentication

Shows the list of integrations for a company

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/integrations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/integrations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Show

requires authentication

Shows a single item of integrations for a company

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/integrations/edbccdf0-fc36-3499-a107-f5936336d97d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/edbccdf0-fc36-3499-a107-f5936336d97d';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/edbccdf0-fc36-3499-a107-f5936336d97d"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyIntegration_uuid   string   

Example: edbccdf0-fc36-3499-a107-f5936336d97d

company_integration_uuid   string  optional  

uuid required The UUID of the company integration that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Store

requires authentication

Create a company integration with empty credential values

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"integration_type_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'integration_type_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "integration_type_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/integrations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

integration_type_uuid   uuid   

The integration type UUID. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update

requires authentication

This endpoint updates the company integration and triggers the sync process (if applicable) if the data is verified and the status is set to active.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/9cc00d5f-0dbf-3fe6-bfd2-79de788b1890" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"credentials\": [
        \"ut\"
    ],
    \"status_uuid\": \"a49ab91f-67a1-30df-9b56-35c9a8e0bcc0\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/9cc00d5f-0dbf-3fe6-bfd2-79de788b1890';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'credentials' => [
                'ut',
            ],
            'status_uuid' => 'a49ab91f-67a1-30df-9b56-35c9a8e0bcc0',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/9cc00d5f-0dbf-3fe6-bfd2-79de788b1890"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "credentials": [
        "ut"
    ],
    "status_uuid": "a49ab91f-67a1-30df-9b56-35c9a8e0bcc0"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyIntegration_uuid   string   

Example: 9cc00d5f-0dbf-3fe6-bfd2-79de788b1890

company_integration_uuid   string  optional  

uuid required The UUID of the company integration that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Body Parameters

credentials   string[]   

The credentials for the company integration

status_uuid   uuid   

The status UUID for company integration Example: a49ab91f-67a1-30df-9b56-35c9a8e0bcc0

Patch

requires authentication

This endpoint patch the company integration and triggers the sync process if the data is verified and the status is set to active.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/eeeefbd7-3d5d-3e35-b6a3-8fe454e5c522" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"credentials\": [
        \"aperiam\"
    ],
    \"status_uuid\": \"b4d716d2-ed9d-3fa7-ae8c-331deff846e4\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/eeeefbd7-3d5d-3e35-b6a3-8fe454e5c522';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'credentials' => [
                'aperiam',
            ],
            'status_uuid' => 'b4d716d2-ed9d-3fa7-ae8c-331deff846e4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/eeeefbd7-3d5d-3e35-b6a3-8fe454e5c522"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "credentials": [
        "aperiam"
    ],
    "status_uuid": "b4d716d2-ed9d-3fa7-ae8c-331deff846e4"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyIntegration_uuid   string   

Example: eeeefbd7-3d5d-3e35-b6a3-8fe454e5c522

company_integration_uuid   string  optional  

uuid required The UUID of the company integration that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Body Parameters

credentials   string[]   

The credentials for the company integration

status_uuid   uuid   

The status uuid for company integration Example: b4d716d2-ed9d-3fa7-ae8c-331deff846e4

Delete

requires authentication

This endpoint allows user to delete a Company Integration.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/e76202e8-1236-3785-8e79-9f03e2a6e55b" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/e76202e8-1236-3785-8e79-9f03e2a6e55b';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/e76202e8-1236-3785-8e79-9f03e2a6e55b"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/integrations/{companyIntegration_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyIntegration_uuid   string   

Example: e76202e8-1236-3785-8e79-9f03e2a6e55b

company_integration_uuid   string  optional  

uuid required The UUID of the company integration that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

List Integration Types

requires authentication

Shows the list of integration types available for a company.
Note: Only administrators have access to certain integration types.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/integrations" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/integrations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/integrations"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/integrations

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Company Symbol

API for company symbol details

List

requires authentication

Shows the list of company symbols with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/symbols" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/symbols

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 18

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 2

sort_by   string  optional  

The column name. Example : name Example: et

sort_order   string  optional  

The order in which you want your records. Example : asc Example: est

search   string  optional  

The general search, it will find matching string. Example : home Example: optio

with_trashed   string  optional  

boolean To display soft deleted data as well. Example : true Example: recusandae

category_uuids   string  optional  

string[] To filter symbols by category. Example : [3245d630-24fd-11ec-accd-e397aec85c7f, 3245d630-24fd-11ec-accd-e397aec85c7f] Example: explicabo

Show

requires authentication

Show a single company symbol.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/symbols/bc06c6f4-6160-3a8f-9983-b677d39651c2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/bc06c6f4-6160-3a8f-9983-b677d39651c2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/bc06c6f4-6160-3a8f-9983-b677d39651c2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/symbols/{companySymbol_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companySymbol_uuid   string   

Example: bc06c6f4-6160-3a8f-9983-b677d39651c2

Store

requires authentication

Store a newly created company symbol.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=minima"\
    --form "source=ullam"\
    --form "description=Et molestiae dolorem neque doloremque culpa reprehenderit nihil."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=dolores"\
    --form "icon_file=@/tmp/phpWU6wT3" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'minima'
            ],
            [
                'name' => 'source',
                'contents' => 'ullam'
            ],
            [
                'name' => 'description',
                'contents' => 'Et molestiae dolorem neque doloremque culpa reprehenderit nihil.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'dolores'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpWU6wT3', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'minima');
body.append('source', 'ullam');
body.append('description', 'Et molestiae dolorem neque doloremque culpa reprehenderit nihil.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'dolores');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/symbols

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the symbol. Example : Dig Example: minima

source   string   

The source of the symbol. Example : text Example: ullam

description   string  optional  

optional The description of the symbol. Example : text Example: Et molestiae dolorem neque doloremque culpa reprehenderit nihil.

icon_url   string  optional  

optional The image url of the symbol. Example: http://smarterlaunch.local/image1.jpg

icon_file   file  optional  

optional The file of the symbol image. Example: /tmp/phpWU6wT3

company_product_uuids   string[]  optional  

of string optional The products of the symbol.

Update

requires authentication

Update a company symbol.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/751b4587-b800-3927-85ed-ac619e0919db" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=aut"\
    --form "source=voluptatum"\
    --form "description=Voluptas dolorum praesentium eius sit similique pariatur."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=sequi"\
    --form "icon_file=@/tmp/phpFgXO92" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/751b4587-b800-3927-85ed-ac619e0919db';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'aut'
            ],
            [
                'name' => 'source',
                'contents' => 'voluptatum'
            ],
            [
                'name' => 'description',
                'contents' => 'Voluptas dolorum praesentium eius sit similique pariatur.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'sequi'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpFgXO92', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/751b4587-b800-3927-85ed-ac619e0919db"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'aut');
body.append('source', 'voluptatum');
body.append('description', 'Voluptas dolorum praesentium eius sit similique pariatur.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'sequi');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/symbols/{companySymbol_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companySymbol_uuid   string   

Example: 751b4587-b800-3927-85ed-ac619e0919db

companySymbolUuid   string   

The uuid of the symbol. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the symbol. Example : Dig Example: aut

source   string   

The source of the symbol. Example : text Example: voluptatum

description   string  optional  

optional The description of the symbol. Example : text Example: Voluptas dolorum praesentium eius sit similique pariatur.

icon_url   string  optional  

optional The image url of the symbol. Example: http://smarterlaunch.local/image1.jpg

icon_file   file  optional  

optional The file of the symbol image. Example: /tmp/phpFgXO92

company_product_uuids   string[]  optional  

of string optional The products of the symbol.

Update

requires authentication

Update a company symbol.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/8dea1ec2-d375-319a-9330-a1fab2744700" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=ipsam"\
    --form "source=aut"\
    --form "description=Quaerat ipsam pariatur est voluptates sed neque voluptates."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=accusamus"\
    --form "icon_file=@/tmp/phplApV20" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/8dea1ec2-d375-319a-9330-a1fab2744700';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'ipsam'
            ],
            [
                'name' => 'source',
                'contents' => 'aut'
            ],
            [
                'name' => 'description',
                'contents' => 'Quaerat ipsam pariatur est voluptates sed neque voluptates.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'accusamus'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phplApV20', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/8dea1ec2-d375-319a-9330-a1fab2744700"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'ipsam');
body.append('source', 'aut');
body.append('description', 'Quaerat ipsam pariatur est voluptates sed neque voluptates.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'accusamus');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/symbols/{companySymbol_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companySymbol_uuid   string   

Example: 8dea1ec2-d375-319a-9330-a1fab2744700

companySymbolUuid   string   

The uuid of the symbol. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the symbol. Example : Dig Example: ipsam

source   string   

The source of the symbol. Example : text Example: aut

description   string  optional  

optional The description of the symbol. Example : text Example: Quaerat ipsam pariatur est voluptates sed neque voluptates.

icon_url   string  optional  

optional The image url of the symbol. Example: http://smarterlaunch.local/image1.jpg

icon_file   file  optional  

optional The file of the symbol image. Example: /tmp/phplApV20

company_product_uuids   string[]  optional  

of string optional The products of the symbol.

Patch

requires authentication

Patch a company symbol.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/5af6df17-226c-38d3-b576-858fc014f8e2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=itaque"\
    --form "source=et"\
    --form "description=Dicta dolor repellat voluptas exercitationem enim atque."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "icon_file=@/tmp/php2a63r2" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/5af6df17-226c-38d3-b576-858fc014f8e2';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'itaque'
            ],
            [
                'name' => 'source',
                'contents' => 'et'
            ],
            [
                'name' => 'description',
                'contents' => 'Dicta dolor repellat voluptas exercitationem enim atque.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/php2a63r2', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/5af6df17-226c-38d3-b576-858fc014f8e2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'itaque');
body.append('source', 'et');
body.append('description', 'Dicta dolor repellat voluptas exercitationem enim atque.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);

fetch(url, {
    method: "PATCH",
    headers,
    body,
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/symbols/{companySymbol_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companySymbol_uuid   string   

Example: 5af6df17-226c-38d3-b576-858fc014f8e2

companySymbolUuid   string   

The uuid of the symbol. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the symbol. Example : Dig Example: itaque

source   string   

The source of the symbol. Example : text Example: et

description   string  optional  

optional The description of the symbol. Example : text Example: Dicta dolor repellat voluptas exercitationem enim atque.

icon_url   string  optional  

optional The image url of the symbol. Example: http://smarterlaunch.local/image1.jpg

icon_file   file  optional  

optional The file of the symbol image. Example: /tmp/php2a63r2

Delete

requires authentication

Delete a company symbol.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/5fdf0332-a052-3f12-83c0-90480fbffbe9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/5fdf0332-a052-3f12-83c0-90480fbffbe9';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/5fdf0332-a052-3f12-83c0-90480fbffbe9"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/symbols/{companySymbol_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companySymbol_uuid   string   

Example: 5fdf0332-a052-3f12-83c0-90480fbffbe9

Support Request

API for Support Request

Store

requires authentication

Send support request from users

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/support-request" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"support_type\": \"\'General Inquiry\'\",
    \"description\": \"\'I cannot access documents. Please help.\'\",
    \"screenshots_url\": [
        \"https:\\/\\/example.net\\/image1.jpg\",
        \"https:\\/\\/example.net\\/image1.png\"
    ],
    \"no_attachments\": false
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/support-request';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'support_type' => '\'General Inquiry\'',
            'description' => '\'I cannot access documents. Please help.\'',
            'screenshots_url' => [
                'https://example.net/image1.jpg',
                'https://example.net/image1.png',
            ],
            'no_attachments' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/support-request"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "support_type": "'General Inquiry'",
    "description": "'I cannot access documents. Please help.'",
    "screenshots_url": [
        "https:\/\/example.net\/image1.jpg",
        "https:\/\/example.net\/image1.png"
    ],
    "no_attachments": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/support-request

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

support_type   string   

The support type. Example: 'General Inquiry'

description   string   

The support request details. Example: 'I cannot access documents. Please help.'

recordings   object  optional  
client_detail   object  optional  
screenshots_url   string[]   

The screenshots URL string.

error_detail   object  optional  
no_attachments   boolean   

Check if request has attachments. Example: false

Upload

requires authentication

Upload photos for Cover Letter or Photo Layout pages

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/support-request-upload/96692378-565b-3d2b-b10f-9d7f23b5f1eb" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "document_template_page_title=Cover Letter"\
    --form "title=Cover Letter Featured Image"\
    --form "decription=Lorem ipsum dolor"\
    --form "append=1"\
    --form "screenshot_file=@/tmp/phpLBBP30" \
    --form "photo_file=@/tmp/php5IaDa1" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/support-request-upload/96692378-565b-3d2b-b10f-9d7f23b5f1eb';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'document_template_page_title',
                'contents' => 'Cover Letter'
            ],
            [
                'name' => 'title',
                'contents' => 'Cover Letter Featured Image'
            ],
            [
                'name' => 'decription',
                'contents' => 'Lorem ipsum dolor'
            ],
            [
                'name' => 'append',
                'contents' => '1'
            ],
            [
                'name' => 'screenshot_file',
                'contents' => fopen('/tmp/phpLBBP30', 'r')
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/php5IaDa1', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/support-request-upload/96692378-565b-3d2b-b10f-9d7f23b5f1eb"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('document_template_page_title', 'Cover Letter');
body.append('title', 'Cover Letter Featured Image');
body.append('decription', 'Lorem ipsum dolor');
body.append('append', '1');
body.append('screenshot_file', document.querySelector('input[name="screenshot_file"]').files[0]);
body.append('photo_file', document.querySelector('input[name="photo_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/support-request-upload/{supportRequest_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

supportRequest_uuid   string   

Example: 96692378-565b-3d2b-b10f-9d7f23b5f1eb

Body Parameters

screenshot_file   file   

Must be a file. Must be an image. Example: /tmp/phpLBBP30

document_template_page_title   string   

The template page title. Example: Cover Letter

photo_file   file   

The photo of template page. Example: /tmp/php5IaDa1

title   string  optional  

optional The title of the photo. Example: Cover Letter Featured Image

decription   string  optional  

optional The description of the photo. Example: Lorem ipsum dolor

append   boolean  optional  

optional Determine whether to append uploaded photo to existing photos of template page. Example: true

Pest Treated

List

requires authentication

Shows the list of pest treated with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/pests-treated

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 4

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 18

sort_by   string  optional  

The column name. Example : name Example: et

sort_order   string  optional  

The order in which you want your records. Example : asc Example: quas

search   string  optional  

The general search, it will find matching string. Example : home Example: rerum

Show

requires authentication

Show a single pest treated.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/ab3872b0-a020-33b9-8059-03ae7b0055d6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/ab3872b0-a020-33b9-8059-03ae7b0055d6';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/ab3872b0-a020-33b9-8059-03ae7b0055d6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/pests-treated/{pestTreated_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

pestTreated_uuid   string   

Example: ab3872b0-a020-33b9-8059-03ae7b0055d6

Store

requires authentication

Store a newly created pest treated.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=nemo"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "pest_treated="\
    --form "photo_file=@/tmp/php3Otfl4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'nemo'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'pest_treated',
                'contents' => ''
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/php3Otfl4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'nemo');
body.append('pest_treated_attributes[attr]', 'value');
body.append('icon_image_url', 'http://smarterlaunch.local/image1.jpg');
body.append('pest_treated', '');
body.append('photo_file', document.querySelector('input[name="photo_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/pests-treated

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the pest treated. Example : Pest Treated 1 Example: nemo

pest_treated_attributes   object   

The attributes of the pest treated.

icon_image_url   string  optional  

optional The image url of the pest treated. Example: http://smarterlaunch.local/image1.jpg

photo_file   file  optional  

optional The file of the pest treated image. Example: /tmp/php3Otfl4

pest_treated   object[]  optional  

optional An array of the above parameters.

Update

requires authentication

Update a pest treated.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/8f5ae2c8-9b11-3108-80d4-a91b91a837d0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=id"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phphpzbR0" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/8f5ae2c8-9b11-3108-80d4-a91b91a837d0';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'id'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phphpzbR0', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/8f5ae2c8-9b11-3108-80d4-a91b91a837d0"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'id');
body.append('pest_treated_attributes[attr]', 'value');
body.append('icon_image_url', 'http://smarterlaunch.local/image1.jpg');
body.append('photo_file', document.querySelector('input[name="photo_file"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/pests-treated/{pestTreated_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

pestTreated_uuid   string   

Example: 8f5ae2c8-9b11-3108-80d4-a91b91a837d0

Body Parameters

name   string   

The name of the pest treated. Example : Pest Treated 1 Example: id

pest_treated_attributes   object   

The attributes of the pest treated.

icon_image_url   string  optional  

optional The image url of the pest treated. Example: http://smarterlaunch.local/image1.jpg

photo_file   file  optional  

optional The file of the pest treated image. Example: /tmp/phphpzbR0

Update

requires authentication

Update a pest treated.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/ff89cf3a-25d5-3e88-aa80-2c95e5c115f0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=sed"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phpb5f3V4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/ff89cf3a-25d5-3e88-aa80-2c95e5c115f0';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'sed'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpb5f3V4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/ff89cf3a-25d5-3e88-aa80-2c95e5c115f0"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'sed');
body.append('pest_treated_attributes[attr]', 'value');
body.append('icon_image_url', 'http://smarterlaunch.local/image1.jpg');
body.append('photo_file', document.querySelector('input[name="photo_file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/pests-treated/{pestTreated_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

pestTreated_uuid   string   

Example: ff89cf3a-25d5-3e88-aa80-2c95e5c115f0

Body Parameters

name   string   

The name of the pest treated. Example : Pest Treated 1 Example: sed

pest_treated_attributes   object   

The attributes of the pest treated.

icon_image_url   string  optional  

optional The image url of the pest treated. Example: http://smarterlaunch.local/image1.jpg

photo_file   file  optional  

optional The file of the pest treated image. Example: /tmp/phpb5f3V4

Patch

requires authentication

Patch a company pest treated.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/a6f2e338-eab0-36a4-82c6-79f6b8a9365d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=asperiores"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phpROFqR2" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/a6f2e338-eab0-36a4-82c6-79f6b8a9365d';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'asperiores'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpROFqR2', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/a6f2e338-eab0-36a4-82c6-79f6b8a9365d"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'asperiores');
body.append('pest_treated_attributes[attr]', 'value');
body.append('icon_image_url', 'http://smarterlaunch.local/image1.jpg');
body.append('photo_file', document.querySelector('input[name="photo_file"]').files[0]);

fetch(url, {
    method: "PATCH",
    headers,
    body,
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/pests-treated/{pestTreated_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

pestTreated_uuid   string   

Example: a6f2e338-eab0-36a4-82c6-79f6b8a9365d

Body Parameters

name   string  optional  

optional The name of the pest treated. Example : Pest Treated 1 Example: asperiores

pest_treated_attributes   object  optional  

optional The attributes of the pest treated.

icon_image_url   string  optional  

optional The image url of the pest treated. Example: http://smarterlaunch.local/image1.jpg

photo_file   file  optional  

optional The file of the pest treated image. Example: /tmp/phpROFqR2

Delete

requires authentication

Delete a pest treated.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/19789b23-ce3f-3374-b35a-26a9d2a6b69b" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/19789b23-ce3f-3374-b35a-26a9d2a6b69b';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/19789b23-ce3f-3374-b35a-26a9d2a6b69b"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/pests-treated/{pestTreated_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

pestTreated_uuid   string   

Example: 19789b23-ce3f-3374-b35a-26a9d2a6b69b

Media Source

API for Media Source

List

requires authentication

Shows the list of media source with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-sources" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/media-sources

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 14

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 9

sort_by   string  optional  

The column name. Example : name Example: aut

sort_order   string  optional  

The order in which you want your records. Example : asc Example: doloribus

search   string  optional  

The general search, it will find matching string. Example : home Example: incidunt

Body Parameters

types   object  optional  
Must be one of:
  • AUDIO
  • IMAGE
  • VIDEO
  • DOCUMENT
  • EMBED

Favorite Media Source List

requires authentication

Get the list of favorite Media Sources

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-sources/favorites" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quidem\",
    \"description\": \"Est assumenda modi non voluptatem quisquam aspernatur illum.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/favorites';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quidem',
            'description' => 'Est assumenda modi non voluptatem quisquam aspernatur illum.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/favorites"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "quidem",
    "description": "Est assumenda modi non voluptatem quisquam aspernatur illum."
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/media-sources/favorites

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the media source. Example : "My media source" Example: quidem

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Est assumenda modi non voluptatem quisquam aspernatur illum.

Show

requires authentication

Show a single media source

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/media-sources/{mediaSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Store

requires authentication

Upload a media source

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/media-sources" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"totam\",
    \"description\": \"Odit dolore saepe inventore et quis consequuntur consequatur.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'totam',
            'description' => 'Odit dolore saepe inventore et quis consequuntur consequatur.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "totam",
    "description": "Odit dolore saepe inventore et quis consequuntur consequatur."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/media-sources

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string  optional  

The name of the file. Example : MyFile.txt Example: totam

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Odit dolore saepe inventore et quis consequuntur consequatur.

Add to Favorite

requires authentication

Add media source to the user company's media source favorites

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/media-sources/1/favorites" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"deserunt\",
    \"description\": \"Qui dolorem eum ipsum ex.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1/favorites';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'deserunt',
            'description' => 'Qui dolorem eum ipsum ex.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1/favorites"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "deserunt",
    "description": "Qui dolorem eum ipsum ex."
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/media-sources/{mediaSource_uuid}/favorites

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media source. Example : "My media source" Example: deserunt

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Qui dolorem eum ipsum ex.

Import CSV

requires authentication

Accept CSV and populate media item data for a media source/manufacturer

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/media-sources/1/import-csv" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpypUTO0" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1/import-csv';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'file',
                'contents' => fopen('/tmp/phpypUTO0', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1/import-csv"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('file', document.querySelector('input[name="file"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/media-sources/{mediaSource_uuid}/import-csv

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Body Parameters

file   file   

The name of the media source. Example : "company.csv" Example: /tmp/phpypUTO0

Update

requires authentication

Update a media source.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/media-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"saepe\",
    \"description\": \"Iste non soluta enim.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'saepe',
            'description' => 'Iste non soluta enim.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "saepe",
    "description": "Iste non soluta enim."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/media-sources/{mediaSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media source. Example : "My media source" Example: saepe

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Iste non soluta enim.

Patch

requires authentication

Patch a media source.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/media-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ex\",
    \"description\": \"Ea expedita aliquam ipsum ullam minus commodi corporis impedit.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ex',
            'description' => 'Ea expedita aliquam ipsum ullam minus commodi corporis impedit.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ex",
    "description": "Ea expedita aliquam ipsum ullam minus commodi corporis impedit."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/media-sources/{mediaSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media source. Example : "My media source" Example: ex

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Ea expedita aliquam ipsum ullam minus commodi corporis impedit.

Delete

requires authentication

Delete a media source.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/media-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/media-sources/{mediaSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Remove Favorite Media Source

requires authentication

Remove media source to the user company's media source favorites

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/media-sources/1/favorites" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"eum\",
    \"description\": \"Consequatur eos qui repudiandae aut.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1/favorites';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'eum',
            'description' => 'Consequatur eos qui repudiandae aut.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1/favorites"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "eum",
    "description": "Consequatur eos qui repudiandae aut."
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

DELETE api/v1/media-sources/{mediaSource_uuid}/favorites

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media source. Example : "My media source" Example: eum

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Consequatur eos qui repudiandae aut.

Proposal Templates

List

requires authentication

Shows the list of ProposalTemplates with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 16

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 14

sort_by   string  optional  

The column name. Example : name Example: enim

sort_order   string  optional  

The order in which you want your records. Example : asc Example: corporis

search   string  optional  

The general search, it will find matching string. Example : home Example: laboriosam

string   string  optional  

The filter for proposal templates with company location in company_locations_uuid. Example: ["725d1dcd-54ad-3a8b-a28e-830c43d8ed6c", "b033658c-4532-3dd7-9be7-64433580eda6"]

Store

requires authentication

Store a newly created Proposal Template.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"8aa4a493-f08c-3e21-b65e-66b5227d610a\",
    \"title\": \"modi\",
    \"description\": \"Qui architecto alias vero rerum at voluptatem saepe tempore.\",
    \"settings\": {
        \"attr\": \"value\"
    },
    \"service_plan_uuids\": [
        \"815d3d9c-f371-3781-8456-7e6954b5b0f5\",
        \"815d3d9c-f371-3781-8456-7e6954b5b0f5\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '8aa4a493-f08c-3e21-b65e-66b5227d610a',
            'title' => 'modi',
            'description' => 'Qui architecto alias vero rerum at voluptatem saepe tempore.',
            'settings' => [
                'attr' => 'value',
            ],
            'service_plan_uuids' => [
                '815d3d9c-f371-3781-8456-7e6954b5b0f5',
                '815d3d9c-f371-3781-8456-7e6954b5b0f5',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "8aa4a493-f08c-3e21-b65e-66b5227d610a",
    "title": "modi",
    "description": "Qui architecto alias vero rerum at voluptatem saepe tempore.",
    "settings": {
        "attr": "value"
    },
    "service_plan_uuids": [
        "815d3d9c-f371-3781-8456-7e6954b5b0f5",
        "815d3d9c-f371-3781-8456-7e6954b5b0f5"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/proposals/templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

company_location_uuid   string   

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 8aa4a493-f08c-3e21-b65e-66b5227d610a

title   string   

The name of the proposal template. Example : Proposal Template 1 Example: modi

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Qui architecto alias vero rerum at voluptatem saepe tempore.

settings   object  optional  

The attributes of the proposal template.

service_plan_uuids   string[]  optional  

The list of ServicePlans to be associated to the ProposalTemplate.

Duplicate

requires authentication

Duplicate a proposal template

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/templates/23bbc8c1-ba5d-357f-bcaa-15b91e453ba5/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates/23bbc8c1-ba5d-357f-bcaa-15b91e453ba5/duplicate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates/23bbc8c1-ba5d-357f-bcaa-15b91e453ba5/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/proposals/templates/{proposalTemplate_uuid}/duplicate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposalTemplate_uuid   string   

Example: 23bbc8c1-ba5d-357f-bcaa-15b91e453ba5

Show

requires authentication

Show a single proposal template.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/templates/a1d94f86-c67a-3179-af05-77ca084018e6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates/a1d94f86-c67a-3179-af05-77ca084018e6';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates/a1d94f86-c67a-3179-af05-77ca084018e6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/templates/{proposalTemplate_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposalTemplate_uuid   string   

Example: a1d94f86-c67a-3179-af05-77ca084018e6

Update

requires authentication

Update a proposal template.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/templates/3a71746e-88bb-3ae9-91aa-95d34f692fc4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"17998de1-3b3f-38e8-ad22-4f645f41e4d2\",
    \"title\": \"quia\",
    \"description\": \"Blanditiis deserunt sequi praesentium asperiores.\",
    \"settings\": {
        \"attr\": \"value\"
    },
    \"service_plan_uuids\": [
        \"815d3d9c-f371-3781-8456-7e6954b5b0f5\",
        \"815d3d9c-f371-3781-8456-7e6954b5b0f5\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates/3a71746e-88bb-3ae9-91aa-95d34f692fc4';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '17998de1-3b3f-38e8-ad22-4f645f41e4d2',
            'title' => 'quia',
            'description' => 'Blanditiis deserunt sequi praesentium asperiores.',
            'settings' => [
                'attr' => 'value',
            ],
            'service_plan_uuids' => [
                '815d3d9c-f371-3781-8456-7e6954b5b0f5',
                '815d3d9c-f371-3781-8456-7e6954b5b0f5',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates/3a71746e-88bb-3ae9-91aa-95d34f692fc4"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "17998de1-3b3f-38e8-ad22-4f645f41e4d2",
    "title": "quia",
    "description": "Blanditiis deserunt sequi praesentium asperiores.",
    "settings": {
        "attr": "value"
    },
    "service_plan_uuids": [
        "815d3d9c-f371-3781-8456-7e6954b5b0f5",
        "815d3d9c-f371-3781-8456-7e6954b5b0f5"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/proposals/templates/{proposalTemplate_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposalTemplate_uuid   string   

Example: 3a71746e-88bb-3ae9-91aa-95d34f692fc4

Body Parameters

company_location_uuid   string   

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 17998de1-3b3f-38e8-ad22-4f645f41e4d2

title   string   

The name of the proposal template. Example : Proposal Template 1 Example: quia

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Blanditiis deserunt sequi praesentium asperiores.

settings   object  optional  

The attributes of the proposal template.

service_plan_uuids   string[]  optional  

The list of ServicePlans to be associated to the ProposalTemplate.

Patch

requires authentication

Patch a company proposal template.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/proposals/templates/65b1695e-8e80-32d2-b15c-b8596e253df8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"a5b9b609-8c32-3a50-85e5-fad806a69b92\",
    \"title\": \"sint\",
    \"description\": \"Quia consequatur nisi repudiandae excepturi facere sunt id sunt.\",
    \"settings\": {
        \"attr\": \"value\"
    },
    \"service_plan_uuids\": [
        \"815d3d9c-f371-3781-8456-7e6954b5b0f5\",
        \"815d3d9c-f371-3781-8456-7e6954b5b0f5\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates/65b1695e-8e80-32d2-b15c-b8596e253df8';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => 'a5b9b609-8c32-3a50-85e5-fad806a69b92',
            'title' => 'sint',
            'description' => 'Quia consequatur nisi repudiandae excepturi facere sunt id sunt.',
            'settings' => [
                'attr' => 'value',
            ],
            'service_plan_uuids' => [
                '815d3d9c-f371-3781-8456-7e6954b5b0f5',
                '815d3d9c-f371-3781-8456-7e6954b5b0f5',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates/65b1695e-8e80-32d2-b15c-b8596e253df8"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "a5b9b609-8c32-3a50-85e5-fad806a69b92",
    "title": "sint",
    "description": "Quia consequatur nisi repudiandae excepturi facere sunt id sunt.",
    "settings": {
        "attr": "value"
    },
    "service_plan_uuids": [
        "815d3d9c-f371-3781-8456-7e6954b5b0f5",
        "815d3d9c-f371-3781-8456-7e6954b5b0f5"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/proposals/templates/{proposalTemplate_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposalTemplate_uuid   string   

Example: 65b1695e-8e80-32d2-b15c-b8596e253df8

Body Parameters

company_location_uuid   string  optional  

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: a5b9b609-8c32-3a50-85e5-fad806a69b92

title   string  optional  

The name of the proposal template. Example : Proposal Template 1 Example: sint

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Quia consequatur nisi repudiandae excepturi facere sunt id sunt.

settings   object  optional  

The attributes of the proposal template.

service_plan_uuids   string[]  optional  

The list of ServicePlans to be associated to the ProposalTemplate.

Delete

requires authentication

Delete a proposal template.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/proposals/templates/43faea47-98d1-37d2-951b-0f53d37c2818" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/templates/43faea47-98d1-37d2-951b-0f53d37c2818';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/templates/43faea47-98d1-37d2-951b-0f53d37c2818"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/proposals/templates/{proposalTemplate_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposalTemplate_uuid   string   

Example: 43faea47-98d1-37d2-951b-0f53d37c2818

Media Item

API for Media Item

List

requires authentication

Shows the list of media items with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_uuid\": \"5f8a5399-e044-39e3-8ae9-d26d9902856e\",
    \"company_location_uuid\": \"e9c5886d-00e2-316f-b910-d987d5e3f7a3\",
    \"media_source_uuid\": \"a629f0dd-7751-3cfc-a51f-b40495b20383\",
    \"include_global_files\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-items';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_uuid' => '5f8a5399-e044-39e3-8ae9-d26d9902856e',
            'company_location_uuid' => 'e9c5886d-00e2-316f-b910-d987d5e3f7a3',
            'media_source_uuid' => 'a629f0dd-7751-3cfc-a51f-b40495b20383',
            'include_global_files' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-items"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_uuid": "5f8a5399-e044-39e3-8ae9-d26d9902856e",
    "company_location_uuid": "e9c5886d-00e2-316f-b910-d987d5e3f7a3",
    "media_source_uuid": "a629f0dd-7751-3cfc-a51f-b40495b20383",
    "include_global_files": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/media-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 15

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 16

sort_by   string  optional  

The column name. Example : name Example: illo

sort_order   string  optional  

The order in which you want your records. Example : asc Example: qui

search   string  optional  

The general search, it will find matching string. Example : home Example: sit

Body Parameters

types   object  optional  
Must be one of:
  • AUDIO
  • IMAGE
  • VIDEO
  • DOCUMENT
  • EMBED
media_tag_names   object  optional  
company_uuid   string  optional  

Must be a valid UUID. Example: 5f8a5399-e044-39e3-8ae9-d26d9902856e

companies_uuid   object  optional  
company_location_uuid   string  optional  

Must be a valid UUID. Example: e9c5886d-00e2-316f-b910-d987d5e3f7a3

company_locations_uuid   object  optional  
media_source_uuid   string  optional  

Must be a valid UUID. Example: a629f0dd-7751-3cfc-a51f-b40495b20383

include_global_files   boolean  optional  

Example: true

Show

requires authentication

Show a single media item

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/media-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-items/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/media-items/{mediaItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaItem_uuid   integer   

Example: 1

Store

requires authentication

Upload a media item

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/media-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=veniam"\
    --form "description=Quod perspiciatis provident et atque amet necessitatibus exercitationem natus."\
    --form "directory=proposal-template"\
    --form "type=document"\
    --form "fileUpload=@/tmp/phpGwwzQ1" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-items';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'veniam'
            ],
            [
                'name' => 'description',
                'contents' => 'Quod perspiciatis provident et atque amet necessitatibus exercitationem natus.'
            ],
            [
                'name' => 'directory',
                'contents' => 'proposal-template'
            ],
            [
                'name' => 'type',
                'contents' => 'document'
            ],
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phpGwwzQ1', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-items"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'veniam');
body.append('description', 'Quod perspiciatis provident et atque amet necessitatibus exercitationem natus.');
body.append('directory', 'proposal-template');
body.append('type', 'document');
body.append('fileUpload', document.querySelector('input[name="fileUpload"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/media-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

name   string  optional  

The name of the file. Example : MyFile.txt Example: veniam

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Quod perspiciatis provident et atque amet necessitatibus exercitationem natus.

directory   string   

The directory where the file will be located. Example: proposal-template

type   string   

The type of the file (in: image, document). Example: document

fileUpload   file   

The file to be uploaded. Example: /tmp/phpGwwzQ1

Update

requires authentication

Update a media item.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/media-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"soluta\",
    \"description\": \"Aut pariatur modi iusto nihil iusto qui aspernatur.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-items/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'soluta',
            'description' => 'Aut pariatur modi iusto nihil iusto qui aspernatur.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "soluta",
    "description": "Aut pariatur modi iusto nihil iusto qui aspernatur."
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/media-items/{mediaItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaItem_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media item. Example : "My media item" Example: soluta

description   string  optional  

The description of the media item. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Aut pariatur modi iusto nihil iusto qui aspernatur.

Patch

requires authentication

Patch a media item.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/media-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ullam\",
    \"description\": \"Iure tempora quos rerum illo ratione et.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-items/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ullam',
            'description' => 'Iure tempora quos rerum illo ratione et.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ullam",
    "description": "Iure tempora quos rerum illo ratione et."
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/media-items/{mediaItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaItem_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media item. Example : "My media item" Example: ullam

description   string  optional  

The description of the media item. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Iure tempora quos rerum illo ratione et.

Delete

requires authentication

Delete a media item.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/media-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-items/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/media-items/{mediaItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaItem_uuid   integer   

Example: 1

Company Product

API for company product details

List

requires authentication

Shows the list of company products with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/products" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/products';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/products"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/products

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 15

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 19

sort_by   string  optional  

The column name. Example : name Example: mollitia

sort_order   string  optional  

The order in which you want your records. Example : asc Example: voluptatem

search   string  optional  

The general search, it will find matching string. Example : home Example: maxime

Show

requires authentication

Show a single company product.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/products/06819e62-bb78-3949-8871-01adf48dc35e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/products/06819e62-bb78-3949-8871-01adf48dc35e';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/products/06819e62-bb78-3949-8871-01adf48dc35e"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/products/{companyProduct_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyProduct_uuid   string   

Example: 06819e62-bb78-3949-8871-01adf48dc35e

Store

requires authentication

Store a newly created company product.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/products" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ut\",
    \"product_attributes\": {
        \"attr\": \"value\"
    },
    \"label_image_url\": \"http:\\/\\/smarterlaunch.local\\/image1.jpg\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/products';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ut',
            'product_attributes' => [
                'attr' => 'value',
            ],
            'label_image_url' => 'http://smarterlaunch.local/image1.jpg',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/products"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ut",
    "product_attributes": {
        "attr": "value"
    },
    "label_image_url": "http:\/\/smarterlaunch.local\/image1.jpg"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/products

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the product. Example : Product 1 Example: ut

product_attributes   object   

The attributes of the product.

label_image_url   string  optional  

optional The image url of the product. Example: http://smarterlaunch.local/image1.jpg

Update

requires authentication

Update a company product.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/products/78b432b3-8378-3c24-a506-82377940e211" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"molestias\",
    \"product_attributes\": {
        \"attr\": \"value\"
    },
    \"label_image_url\": \"http:\\/\\/smarterlaunch.local\\/image1.jpg\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/products/78b432b3-8378-3c24-a506-82377940e211';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'molestias',
            'product_attributes' => [
                'attr' => 'value',
            ],
            'label_image_url' => 'http://smarterlaunch.local/image1.jpg',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/products/78b432b3-8378-3c24-a506-82377940e211"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "molestias",
    "product_attributes": {
        "attr": "value"
    },
    "label_image_url": "http:\/\/smarterlaunch.local\/image1.jpg"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/products/{companyProduct_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyProduct_uuid   string   

Example: 78b432b3-8378-3c24-a506-82377940e211

Body Parameters

name   string   

The name of the product. Example : Product 1 Example: molestias

product_attributes   object   

The attributes of the product.

label_image_url   string  optional  

optional The image url of the product. Example: http://smarterlaunch.local/image1.jpg

Patch

requires authentication

Patch a company product.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/products/39efcfea-e78d-3223-9cf7-86930e00f11d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"necessitatibus\",
    \"product_attributes\": {
        \"attr\": \"value\"
    },
    \"label_image_url\": \"http:\\/\\/smarterlaunch.local\\/image1.jpg\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/products/39efcfea-e78d-3223-9cf7-86930e00f11d';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'necessitatibus',
            'product_attributes' => [
                'attr' => 'value',
            ],
            'label_image_url' => 'http://smarterlaunch.local/image1.jpg',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/products/39efcfea-e78d-3223-9cf7-86930e00f11d"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "necessitatibus",
    "product_attributes": {
        "attr": "value"
    },
    "label_image_url": "http:\/\/smarterlaunch.local\/image1.jpg"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/products/{companyProduct_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyProduct_uuid   string   

Example: 39efcfea-e78d-3223-9cf7-86930e00f11d

Body Parameters

name   string  optional  

optional The name of the product. Example : Product 1 Example: necessitatibus

product_attributes   object  optional  

optional The attributes of the product.

label_image_url   string  optional  

optional The image url of the product. Example: http://smarterlaunch.local/image1.jpg

Delete

requires authentication

Delete a product.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/products/91cda1b8-1c0b-3d94-99f9-dbd7a0a99912" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/products/91cda1b8-1c0b-3d94-99f9-dbd7a0a99912';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/products/91cda1b8-1c0b-3d94-99f9-dbd7a0a99912"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/products/{companyProduct_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyProduct_uuid   string   

Example: 91cda1b8-1c0b-3d94-99f9-dbd7a0a99912

Tag

API for Tag

List

requires authentication

Shows the list of tags with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/import-set-tags" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-set-tags';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-set-tags"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/import-set-tags

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 15

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 11

sort_by   string  optional  

The column name. Example : name Example: et

sort_order   string  optional  

The order in which you want your records. Example : asc Example: voluptatem

search   string  optional  

The general search, it will find matching string. Example : "Pest Control" Example: praesentium

Permission

API for permission details

List / Fetch

requires authentication

Shows the list of permission or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"name\": \"user-list\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/permissions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'name' => 'user-list',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "name": "user-list"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string  optional  

optional The uuid of the permission. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

name   string   

The name of the permission. Example: user-list

List / Fetch

requires authentication

Shows the list of permission or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"name\": \"user-list\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/permissions/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'name' => 'user-list',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "name": "user-list"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/permissions/{permissionUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionUuid   integer   

Example: 1

Body Parameters

uuid   string  optional  

optional The uuid of the permission. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

name   string   

The name of the permission. Example: user-list

Create / Update permission.

requires authentication

This endpoint lets user to create/update permission.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"user-list\",
    \"uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/permissions';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'user-list',
            'uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/permissions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "user-list",
    "uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the permission. Example: user-list

uuid   string  optional  

optional The uuid of the permission. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

Create / Update permission.

requires authentication

This endpoint lets user to create/update permission.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"user-list\",
    \"uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/permissions/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'user-list',
            'uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "user-list",
    "uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/permissions/{permissionUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionUuid   integer   

Example: 1

Body Parameters

name   string   

The name of the permission. Example: user-list

uuid   string  optional  

optional The uuid of the permission. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

Delete

requires authentication

This endpoint allows user to delete permission.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/permissions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/permissions/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/permissions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/permissions/{permissionUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionUuid   integer   

Example: 1

uuid   string   

The uuid of the permission. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Company File

API for Company File

Store

requires authentication

Upload a file into a company

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/files" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=eos"\
    --form "description=Ad accusamus iure laborum quis magnam."\
    --form "directory=proposal-template"\
    --form "type=document"\
    --form "fileUpload=@/tmp/phplYJXB4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/files';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'eos'
            ],
            [
                'name' => 'description',
                'contents' => 'Ad accusamus iure laborum quis magnam.'
            ],
            [
                'name' => 'directory',
                'contents' => 'proposal-template'
            ],
            [
                'name' => 'type',
                'contents' => 'document'
            ],
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phplYJXB4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/files"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('name', 'eos');
body.append('description', 'Ad accusamus iure laborum quis magnam.');
body.append('directory', 'proposal-template');
body.append('type', 'document');
body.append('fileUpload', document.querySelector('input[name="fileUpload"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/files

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the file. Example : MyFile.txt Example: eos

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Ad accusamus iure laborum quis magnam.

directory   string   

The directory where the file will be located. Example: proposal-template

type   string   

The type of the file (in: image, document). Example: document

fileUpload   file   

The file to be uploaded. Example: /tmp/phplYJXB4

Delete

requires authentication

Delete a file from a company

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/files" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"file_url\": \"http:\\/\\/powlowski.com\\/ut-ipsa-eveniet-dignissimos-voluptatem\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/files';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'file_url' => 'http://powlowski.com/ut-ipsa-eveniet-dignissimos-voluptatem',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/files"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "file_url": "http:\/\/powlowski.com\/ut-ipsa-eveniet-dignissimos-voluptatem"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/files

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

file_url   string  optional  

or array The url of the file. Example : MyFile.txt Example: http://powlowski.com/ut-ipsa-eveniet-dignissimos-voluptatem

Country

API for country details

List / Fetch

Shows the list of country or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/countries" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"name\": \"baroda\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/countries';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'name' => 'baroda',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/countries"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "name": "baroda"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/countries

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string  optional  

optional The country uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

name   string  optional  

optional The country name. Example: baroda

List / Fetch

Shows the list of country or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/countries/6cf782f3-833e-3aff-9fa5-b9c6d0d7ba5a" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"name\": \"baroda\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/countries/6cf782f3-833e-3aff-9fa5-b9c6d0d7ba5a';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'name' => 'baroda',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/countries/6cf782f3-833e-3aff-9fa5-b9c6d0d7ba5a"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "name": "baroda"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/countries/{countryUuid}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

countryUuid   string   

Example: 6cf782f3-833e-3aff-9fa5-b9c6d0d7ba5a

Body Parameters

uuid   string  optional  

optional The country uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

name   string  optional  

optional The country name. Example: baroda

Get country states using country uuid.

Shows the list of states using country uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/countries/cdcae8de-4986-3747-a39c-8930f143ca8b/states" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/countries/cdcae8de-4986-3747-a39c-8930f143ca8b/states';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/countries/cdcae8de-4986-3747-a39c-8930f143ca8b/states"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/countries/{countryUuid}/states

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

countryUuid   string   

Example: cdcae8de-4986-3747-a39c-8930f143ca8b

country_uuid   string   

The country uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Solution Category

API for Solution Category

List

requires authentication

Shows the list of solution categories.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solution-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"include_fields\": [
        \"solutions\"
    ],
    \"ignore_cached\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'include_fields' => [
                'solutions',
            ],
            'ignore_cached' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "include_fields": [
        "solutions"
    ],
    "ignore_cached": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/solution-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 8

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 17

sort_by   string  optional  

The column name. Example : name Example: voluptas

sort_order   string  optional  

The order in which you want your records. Example : asc Example: et

search   string  optional  

The general search, it will find matching string. Example : home Example: et

filter_by_parent_solution_category_uuids   string  optional  

array To filter the list of solution categories by parent solution category. Example : ["3c787d66-2a4f-3f1d-9591-c330be0abe82"] Example: minima

Body Parameters

include_fields   string[]  optional  
Must be one of:
  • user_progress
  • solutions
ignore_cached   boolean  optional  

Example: true

Show

requires authentication

Show a single solution category.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solution-categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/solution-categories/{solutionCategory_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Store

requires authentication

Store a new solution category.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/solution-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ea\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"parent_solution_category_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ea',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'parent_solution_category_uuid' => '"3c787d66-2a4f-3f1d-9591-c330be0abe82"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ea",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "parent_solution_category_uuid": "\"3c787d66-2a4f-3f1d-9591-c330be0abe82\""
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/solution-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the solution category. Example : Solution Category 1 Example: ea

description   string   

The attributes of the solution category. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

parent_solution_category_uuid   string  optional  

optional The parent of the solution category. Example: "3c787d66-2a4f-3f1d-9591-c330be0abe82"

Update

requires authentication

Update a solution category.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solution-categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ea\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"parent_solution_category_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ea',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'parent_solution_category_uuid' => '"3c787d66-2a4f-3f1d-9591-c330be0abe82"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ea",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "parent_solution_category_uuid": "\"3c787d66-2a4f-3f1d-9591-c330be0abe82\""
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/solution-categories/{solutionCategory_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the solution category. Example : Proposal Creation Example: ea

description   string   

The attributes of the solution category. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

parent_solution_category_uuid   string  optional  

optional The parent of the solution category. Example: "3c787d66-2a4f-3f1d-9591-c330be0abe82"

Reset

requires authentication

Reset a solution category user progress.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solution-categories/1/reset" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1/reset';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1/reset"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/v1/solution-categories/{solutionCategory_uuid}/reset

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Update user progress

requires authentication

Update user progress.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solution-categories/1/user-progress" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_completed\": true,
    \"step\": []
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1/user-progress';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'is_completed' => true,
            'step' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1/user-progress"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "is_completed": true,
    "step": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/solution-categories/{solutionCategory_uuid}/user-progress

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Body Parameters

is_completed   boolean  optional  

The solution category of the solution. Example : false Example: true

step   object  optional  

The current step the use is on. Example : 2

Patch Index

requires authentication

Performs specific updates for solution categories

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/solution-categories/1/sort" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1/sort';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1/sort"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/solution-categories/{solutionCategory_uuid}/sort

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

solution_categories_ranking_list   string  optional  

string[] A dictionary of uuids with uuid as key and rank as the value. Example : {"69e56cdf-cea8-4356-b35d-58d610aba886" : 1, "9c578b77-916a-4620-a246-fa951f422912" : 2} Example: iste

Patch

requires authentication

Patch a solution category.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/solution-categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sit\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"parent_solution_category_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'sit',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'parent_solution_category_uuid' => '"3c787d66-2a4f-3f1d-9591-c330be0abe82"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sit",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "parent_solution_category_uuid": "\"3c787d66-2a4f-3f1d-9591-c330be0abe82\""
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/solution-categories/{solutionCategory_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the solution category. Example : Proposal Creation Example: sit

description   string   

The attributes of the solution category. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

parent_solution_category_uuid   string  optional  

optional The parent of the solution category. Example: "3c787d66-2a4f-3f1d-9591-c330be0abe82"

Delete

requires authentication

Delete a solution category.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/solution-categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/solution-categories/{solutionCategory_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Solution Feedback

API for Solution Feedback

List

requires authentication

Shows the list of solution feedbacks.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solutions/1/feedback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/solutions/{solution_uuid}/feedback

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 2

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 16

sort_by   string  optional  

The column name. Example : name Example: quis

sort_order   string  optional  

The order in which you want your records. Example : asc Example: et

search   string  optional  

The general search, it will find matching string. Example : home Example: est

Show

requires authentication

Show a single solution.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/e9b9f708-204c-310f-8665-f341ef709744" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/e9b9f708-204c-310f-8665-f341ef709744';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/e9b9f708-204c-310f-8665-f341ef709744"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/solutions/{solution_uuid}/feedback/{solutionFeedback_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

solutionFeedback_uuid   string   

Example: e9b9f708-204c-310f-8665-f341ef709744

Store

requires authentication

Store a new solution feedback.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 4,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 4,
            'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "rate": 4,
    "feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/solutions/{solution_uuid}/feedback

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Body Parameters

rate   integer   

The name of the solution. Example : 5 Example: 4

feedback   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

Update

requires authentication

Update a solution .

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/9bf3bf27-c5bc-3d66-8e32-1def90d6494e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 19,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/9bf3bf27-c5bc-3d66-8e32-1def90d6494e';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 19,
            'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/9bf3bf27-c5bc-3d66-8e32-1def90d6494e"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "rate": 19,
    "feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/solutions/{solution_uuid}/feedback/{solutionFeedback_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

solutionFeedback_uuid   string   

Example: 9bf3bf27-c5bc-3d66-8e32-1def90d6494e

Body Parameters

rate   integer   

The name of the solution. Example : 5 Example: 19

feedback   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

Patch

requires authentication

Patch a solution feedback.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/e0836cbb-a433-3f2e-9bfc-e8196bddb708" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 15,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/e0836cbb-a433-3f2e-9bfc-e8196bddb708';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 15,
            'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/e0836cbb-a433-3f2e-9bfc-e8196bddb708"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "rate": 15,
    "feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/solutions/{solution_uuid}/feedback/{solutionFeedback_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

solutionFeedback_uuid   string   

Example: e0836cbb-a433-3f2e-9bfc-e8196bddb708

Body Parameters

rate   integer   

The name of the solution. Example : 5 Example: 15

feedback   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

Delete

requires authentication

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/50fc5835-0345-3e96-abf8-c362ab1ff9ff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/50fc5835-0345-3e96-abf8-c362ab1ff9ff';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/50fc5835-0345-3e96-abf8-c362ab1ff9ff"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/solutions/{solution_uuid}/feedback/{solutionFeedback_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

solutionFeedback_uuid   string   

Example: 50fc5835-0345-3e96-abf8-c362ab1ff9ff

Company Users

API for company details

List

requires authentication

Shows the list of company users that the user has access to view.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/users?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ignore_cached\": true,
    \"should_reset_cache\": true,
    \"page_size\": 15,
    \"sort_by\": \"display_name\",
    \"sort_order\": \"asc\",
    \"search\": \"John\",
    \"filter_by_status_code\": \"STATUS_ACTIVE \\/ [\\\"STATUS_ACTIVE\\\".\\\"STATUS_DISABLED\\\"]\",
    \"filter_by_role_code\": \"ROLE_COMPANY_MANAGER\",
    \"filter_by_company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'page' => '1',
        ],
        'json' => [
            'ignore_cached' => true,
            'should_reset_cache' => true,
            'page_size' => 15,
            'sort_by' => 'display_name',
            'sort_order' => 'asc',
            'search' => 'John',
            'filter_by_status_code' => 'STATUS_ACTIVE / ["STATUS_ACTIVE"."STATUS_DISABLED"]',
            'filter_by_role_code' => 'ROLE_COMPANY_MANAGER',
            'filter_by_company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users"
);

const params = {
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ignore_cached": true,
    "should_reset_cache": true,
    "page_size": 15,
    "sort_by": "display_name",
    "sort_order": "asc",
    "search": "John",
    "filter_by_status_code": "STATUS_ACTIVE \/ [\"STATUS_ACTIVE\".\"STATUS_DISABLED\"]",
    "filter_by_role_code": "ROLE_COMPANY_MANAGER",
    "filter_by_company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyUuid   string   

The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Query Parameters

page   integer  optional  

optional The page number. Example: 1

Body Parameters

include_fields   string[]  optional  
ignore_cached   boolean  optional  

Example: true

should_reset_cache   boolean  optional  

optional Resets the cache Example: true

page_size   integer  optional  

optional The number of records you want per page. Example: 15

sort_by   string  optional  

optional The column name. Example: display_name

sort_order   string  optional  

optional The order in which you want your records. Example: asc

search   string  optional  

optional The general search, it will find matching string. Example: John

filter_by_status_code   string/array  optional  

optional Filter results by user status. Example: STATUS_ACTIVE / ["STATUS_ACTIVE"."STATUS_DISABLED"]

filter_by_role_code   string  optional  

optional Filter results by user role. Example: ROLE_COMPANY_MANAGER

filter_by_company_location_uuid   string  optional  

uuid optional Filter results by company location uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Show

requires authentication

Shows detail of a specific company user

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users/3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/users/{userOrUserInviteUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

userOrUserInviteUuid   integer   

Example: 3

Send invitation to user.

requires authentication

This endpoint lets company owner to send invite to its sub-user.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"email\": \"hello@smarterlaunch.com\",
    \"role_uuid\": \"45955590-4152-11ec-9c77-2181a8ee04db\",
    \"company_locations\": [],
    \"last_name\": \"Smith\",
    \"company_locations[]\": \"[\\\"45955590-4152-11ec-9c77-2181a8ee04db\\\"]\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'first_name' => 'John',
            'email' => 'hello@smarterlaunch.com',
            'role_uuid' => '45955590-4152-11ec-9c77-2181a8ee04db',
            'company_locations' => [],
            'last_name' => 'Smith',
            'company_locations[]' => '["45955590-4152-11ec-9c77-2181a8ee04db"]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "email": "hello@smarterlaunch.com",
    "role_uuid": "45955590-4152-11ec-9c77-2181a8ee04db",
    "company_locations": [],
    "last_name": "Smith",
    "company_locations[]": "[\"45955590-4152-11ec-9c77-2181a8ee04db\"]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

first_name   string   

The first name of the user. Example: John

email   string   

The email of the user. Example: hello@smarterlaunch.com

role_uuid   string  optional  

uuid required The role uuid of the user. Example: 45955590-4152-11ec-9c77-2181a8ee04db

company_locations   object   
last_name   string   

The first name of the user. Example: Smith

company_locations[]   string  optional  

uuid of The company location. Example: ["45955590-4152-11ec-9c77-2181a8ee04db"]

Resend invitation to user.

requires authentication

This endpoint lets company owner to send invite to its sub-user.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3245d630-24fd-11ec-accd-e397aec85c7f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users/3245d630-24fd-11ec-accd-e397aec85c7f';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3245d630-24fd-11ec-accd-e397aec85c7f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/users/{uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

uuid   string   

The invited user uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Force activate user

requires authentication

This endpoint lets admin/super admin to activate user.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3/activate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users/3/activate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3/activate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/users/{userInviteUuid}/activate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

userInviteUuid   integer   

Example: 3

uuid   string   

The invited user uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update

requires authentication

This endpoint lets the user update company user.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Smith\",
    \"email\": \"hello@smarterlaunch.com\",
    \"role_uuid\": \"45955590-4152-11ec-9c77-2181a8ee04db\",
    \"company_locations\": [
        \"3245d630-24fd-11ec-accd-e397aec85c7f\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users/3';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'first_name' => 'John',
            'last_name' => 'Smith',
            'email' => 'hello@smarterlaunch.com',
            'role_uuid' => '45955590-4152-11ec-9c77-2181a8ee04db',
            'company_locations' => [
                '3245d630-24fd-11ec-accd-e397aec85c7f',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "last_name": "Smith",
    "email": "hello@smarterlaunch.com",
    "role_uuid": "45955590-4152-11ec-9c77-2181a8ee04db",
    "company_locations": [
        "3245d630-24fd-11ec-accd-e397aec85c7f"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/users/{userUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

userUuid   integer   

Example: 3

Body Parameters

first_name   string   

The first name of the user. Example: John

last_name   string   

The first name of the user. Example: Smith

email   string   

The email of the user. Example: hello@smarterlaunch.com

role_uuid   string  optional  

uuid required The role uuid of the user. Example: 45955590-4152-11ec-9c77-2181a8ee04db

company_locations   object[]  optional  

array of uuid required The company location.

Patch

requires authentication

This endpoint lets the user patch company user.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"role_uuid\": \"45955590-4152-11ec-9c77-2181a8ee04db\",
    \"company_locations\": [
        \"3245d630-24fd-11ec-accd-e397aec85c7f\"
    ],
    \"status_uuid\": \"f6a1e06d-e1b9-3ac8-a327-88457dfe1eb3\",
    \"last_name\": \"Smith\",
    \"email\": \"hello@smarterlaunch.com\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users/3';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'first_name' => 'John',
            'role_uuid' => '45955590-4152-11ec-9c77-2181a8ee04db',
            'company_locations' => [
                '3245d630-24fd-11ec-accd-e397aec85c7f',
            ],
            'status_uuid' => 'f6a1e06d-e1b9-3ac8-a327-88457dfe1eb3',
            'last_name' => 'Smith',
            'email' => 'hello@smarterlaunch.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "role_uuid": "45955590-4152-11ec-9c77-2181a8ee04db",
    "company_locations": [
        "3245d630-24fd-11ec-accd-e397aec85c7f"
    ],
    "status_uuid": "f6a1e06d-e1b9-3ac8-a327-88457dfe1eb3",
    "last_name": "Smith",
    "email": "hello@smarterlaunch.com"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/users/{userUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

userUuid   integer   

Example: 3

Body Parameters

first_name   string   

The first name of the user. Example: John

role_uuid   string  optional  

uuid required The role uuid of the user. Example: 45955590-4152-11ec-9c77-2181a8ee04db

company_locations   object[]  optional  

array of uuid required The company location.

status_uuid   string  optional  

Must be a valid UUID. Example: f6a1e06d-e1b9-3ac8-a327-88457dfe1eb3

last_name   string   

The first name of the user. Example: Smith

email   string   

The email of the user. Example: hello@smarterlaunch.com

Delete

requires authentication

This endpoint allows owner to delete a user.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3245d630-24fd-11ec-accd-e397aec85c7f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/users/3245d630-24fd-11ec-accd-e397aec85c7f';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/users/3245d630-24fd-11ec-accd-e397aec85c7f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/users/{userUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

userUuid   string   

The uuid of the company user to be removed. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyUuid   string   

The uuid of the company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Company Field Group

API for Company field group details

List

requires authentication

Shows the list of company custom field groups with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/custom-field-groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 10

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 1

sort_by   string  optional  

The column name. Example : name Example: fugiat

sort_order   string  optional  

The order in which you want your records. Example : asc Example: enim

search   string  optional  

The general search, it will find matching string. Example : home Example: numquam

with_trashed   string  optional  

boolean To display soft deleted data as well. Example : true Example: porro

assignment   string  optional  

To filter data by assignment. Example : CUSTOMER_ADDRESS Example: iste

Show

requires authentication

Show a single company custom field group.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/b7967fe5-3111-3f2f-b798-61a21ffe2932" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/b7967fe5-3111-3f2f-b798-61a21ffe2932';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/b7967fe5-3111-3f2f-b798-61a21ffe2932"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/custom-field-groups/{companyCustomFieldGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyCustomFieldGroup_uuid   string   

Example: b7967fe5-3111-3f2f-b798-61a21ffe2932

Store

requires authentication

Store a newly created company custom field group.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qui\",
    \"assignment\": \"quia\",
    \"company_custom_fields\": [
        \"odio\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'qui',
            'assignment' => 'quia',
            'company_custom_fields' => [
                'odio',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "qui",
    "assignment": "quia",
    "company_custom_fields": [
        "odio"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/custom-field-groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the custom field group. Example : Additional Details Example: qui

assignment   enum  optional  

CUSTOMER|CUSTOMER_ADDRESS|MY_ACCOUNT|COMPANY|COMPANY_LOCATION required The assignment of the custom field group. Example : CUSTOMER Example: quia

company_custom_fields   string[]  optional  

of object required The company_custom_fields of the custom field group. Example : [{label: 'Address 3', input_type: 'TEXT}]

Update

requires authentication

Update a company custom field group.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/fd8395ad-9c1a-3a79-9f59-0db7cec2b024" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dolores\",
    \"assignment\": \"cumque\",
    \"company_custom_fields\": [
        \"aliquid\"
    ],
    \"deleted_custom_field_uuids\": [
        \"aperiam\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/fd8395ad-9c1a-3a79-9f59-0db7cec2b024';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'dolores',
            'assignment' => 'cumque',
            'company_custom_fields' => [
                'aliquid',
            ],
            'deleted_custom_field_uuids' => [
                'aperiam',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/fd8395ad-9c1a-3a79-9f59-0db7cec2b024"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "dolores",
    "assignment": "cumque",
    "company_custom_fields": [
        "aliquid"
    ],
    "deleted_custom_field_uuids": [
        "aperiam"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/custom-field-groups/{companyCustomFieldGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyCustomFieldGroup_uuid   string   

Example: fd8395ad-9c1a-3a79-9f59-0db7cec2b024

companyCustomFieldGroupUuid   string   

The uuid of the custom field group. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the custom field group. Example : Additional Details Example: dolores

assignment   enum  optional  

CUSTOMER|CUSTOMER_ADDRESS|MY_ACCOUNT|COMPANY|COMPANY_LOCATION required The assignment of the custom field group. Example : CUSTOMER Example: cumque

company_custom_fields   string[]  optional  

of object required The company_custom_fields of the custom field group. Example : [{label: 'Address 3', input_type: 'TEXT}]

deleted_custom_field_uuids   string[]  optional  

of uuid required The deleted_custom_field_uuids of the custom field group. Example : ["3245d630-24fd-11ec-accd-e397aec85c7f", "3245d630-24fd-11ec-accd-e397aec85c7f"]

Patch

requires authentication

Patch a company custom field group.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/811840a4-2cc4-3751-bda0-73c1884fd93e" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"repellat\",
    \"assignment\": \"totam\",
    \"company_custom_fields\": [
        \"amet\"
    ],
    \"deleted_custom_field_uuids\": [
        \"eius\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/811840a4-2cc4-3751-bda0-73c1884fd93e';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'repellat',
            'assignment' => 'totam',
            'company_custom_fields' => [
                'amet',
            ],
            'deleted_custom_field_uuids' => [
                'eius',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/811840a4-2cc4-3751-bda0-73c1884fd93e"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "repellat",
    "assignment": "totam",
    "company_custom_fields": [
        "amet"
    ],
    "deleted_custom_field_uuids": [
        "eius"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/custom-field-groups/{companyCustomFieldGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyCustomFieldGroup_uuid   string   

Example: 811840a4-2cc4-3751-bda0-73c1884fd93e

companyCustomFieldGroupUuid   string   

The uuid of the custom field group. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of the custom field group. Example : Additional Details Example: repellat

assignment   enum  optional  

CUSTOMER|CUSTOMER_ADDRESS|MY_ACCOUNT|COMPANY|COMPANY_LOCATION required The assignment of the custom field group. Example : CUSTOMER Example: totam

company_custom_fields   string[]  optional  

of object required The company_custom_fields of the custom field group. Example : [{label: 'Address 3', input_type: 'TEXT}]

deleted_custom_field_uuids   string[]  optional  

of uuid required The deleted_custom_field_uuids of the custom field group. Example : ["3245d630-24fd-11ec-accd-e397aec85c7f", "3245d630-24fd-11ec-accd-e397aec85c7f"]

Delete

requires authentication

Delete a company custom field group.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/6e3a5eae-965f-3f57-936a-c6e943b556f6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/6e3a5eae-965f-3f57-936a-c6e943b556f6';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/6e3a5eae-965f-3f57-936a-c6e943b556f6"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/custom-field-groups/{companyCustomFieldGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyCustomFieldGroup_uuid   string   

Example: 6e3a5eae-965f-3f57-936a-c6e943b556f6

Other Endpoints

POST api/v1/upload-from-url

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/upload-from-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"http:\\/\\/www.stiedemann.com\\/\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/upload-from-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'url' => 'http://www.stiedemann.com/',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/upload-from-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "url": "http:\/\/www.stiedemann.com\/"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/upload-from-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

url   string   

Must be a valid URL. Example: http://www.stiedemann.com/

POST api/v1/auth/webhook-receiving-url

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/webhook-receiving-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/webhook-receiving-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/webhook-receiving-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/auth/webhook-receiving-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Test

requires authentication

Save new webhook subscription

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/auth/webhooks/subscribe-test" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"\'http:\\/\\/zapier.com\\/customer-created-in-smarterlaunch\'\",
    \"event\": \"customer-create\'\",
    \"type\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/auth/webhooks/subscribe-test';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'url' => '\'http://zapier.com/customer-created-in-smarterlaunch\'',
            'event' => 'customer-create\'',
            'type' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/auth/webhooks/subscribe-test"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "url": "'http:\/\/zapier.com\/customer-created-in-smarterlaunch'",
    "event": "customer-create'",
    "type": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/auth/webhooks/subscribe-test

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

url   string   

The url where smarterlaunch submit data when particular events are triggered. Example: 'http://zapier.com/customer-created-in-smarterlaunch'

event   string   

To determine what kind of trigger the webhook is for. Example: customer-create'

type   boolean   

Check To determine what integration the incoming webhook is for. Example: true

POST Get S3 Pre-signed Url for Proposal Review

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/proposal-file-upload-presigned-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"signature_photo\": {
        \"full_path\": \"\\/test\\/signature.png\",
        \"md5_hash\": \"#hash#\",
        \"extension\": \"png\"
    },
    \"proposal_pdf\": {
        \"full_path\": \"\\/test\\/proposal.pdf\",
        \"md5_hash\": \"#hash#\",
        \"extension\": \"pdf\"
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/proposal-file-upload-presigned-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'signature_photo' => [
                'full_path' => '/test/signature.png',
                'md5_hash' => '#hash#',
                'extension' => 'png',
            ],
            'proposal_pdf' => [
                'full_path' => '/test/proposal.pdf',
                'md5_hash' => '#hash#',
                'extension' => 'pdf',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/proposal-file-upload-presigned-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "signature_photo": {
        "full_path": "\/test\/signature.png",
        "md5_hash": "#hash#",
        "extension": "png"
    },
    "proposal_pdf": {
        "full_path": "\/test\/proposal.pdf",
        "md5_hash": "#hash#",
        "extension": "pdf"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/proposal-file-upload-presigned-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

signature_photo   object   

The signature image file object {"full_path": string, "md5_hash": string, "extension": string}.

proposal_pdf   object   

The pdf file object {"full_path": string, "md5_hash": string, "extension": string}.

POST Get S3 Pre-signed Url

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/file-upload-presigned-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items[]\": \"[{\\\"path\\\": \\\"\\/companies\\/{company-uuid}\\/\\\", \\\"extension\\\": \\\"jpg\\\"}]\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/file-upload-presigned-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'items[]' => '[{"path": "/companies/{company-uuid}/", "extension": "jpg"}]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/file-upload-presigned-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "items[]": "[{\"path\": \"\/companies\/{company-uuid}\/\", \"extension\": \"jpg\"}]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/file-upload-presigned-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

items[]   $items  optional  

An array of ['path' => string, 'extension' => string, 'md5_hash' => string, 'is_full_path' => boolean]. Example: [{"path": "/companies/{company-uuid}/", "extension": "jpg"}]

POST Get S3 Pre-signed Url

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/file-upload-presigned-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items[]\": \"[{\\\"path\\\": \\\"\\/companies\\/{company-uuid}\\/\\\", \\\"extension\\\": \\\"jpg\\\"}]\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/file-upload-presigned-url';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'items[]' => '[{"path": "/companies/{company-uuid}/", "extension": "jpg"}]',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/file-upload-presigned-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "items[]": "[{\"path\": \"\/companies\/{company-uuid}\/\", \"extension\": \"jpg\"}]"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/file-upload-presigned-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

items[]   $items  optional  

An array of ['path' => string, 'extension' => string, 'md5_hash' => string, 'is_full_path' => boolean]. Example: [{"path": "/companies/{company-uuid}/", "extension": "jpg"}]

List

requires authentication

Shows the list of line items with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/line-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/line-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 18

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 1

sort_by   string  optional  

The column name. Example : name Example: iste

sort_order   string  optional  

The order in which you want your records. Example : asc Example: molestias

search   string  optional  

The general search, it will find matching string. Example : home Example: neque

Show

requires authentication

Show a single line item.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/line-items/{lineItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

lineItem_uuid   integer   

Example: 1

Store

requires authentication

Store a new line item.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"aut\",
    \"description\": \"Repellendus deleniti omnis qui est.\",
    \"line_item_values\": \"libero\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'aut',
            'description' => 'Repellendus deleniti omnis qui est.',
            'line_item_values' => 'libero',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "aut",
    "description": "Repellendus deleniti omnis qui est.",
    "line_item_values": "libero"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/line-items

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the line item. Example : "Termite Pesticide" Example: aut

description   string   

The description of the line item. Example : "Termite Pesticide" Example: Repellendus deleniti omnis qui est.

line_item_values   string   

The data of the line item. Example : {"price": [100, 100]} Example: libero

Import Set to Line Items

requires authentication

Store a newly created import set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"import_files\": \"dolores\",
    \"override\": false
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items/import';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'import_files' => 'dolores',
            'override' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/import"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "import_files": "dolores",
    "override": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/line-items/import

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

import_files   files   

The set of json files containing import settings data. Example: dolores

override   boolean   

Determine if the import set will replace the current ones with matching names. Example: false

Update

requires authentication

Update a line item.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pariatur\",
    \"description\": \"Reprehenderit maiores possimus illo.\",
    \"line_item_values\": \"quia\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'pariatur',
            'description' => 'Reprehenderit maiores possimus illo.',
            'line_item_values' => 'quia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "pariatur",
    "description": "Reprehenderit maiores possimus illo.",
    "line_item_values": "quia"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/line-items/{lineItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

lineItem_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the line item. Example : "Termite Pesticide" Example: pariatur

description   string  optional  

The description of the line item. Example : "Termite Pesticide" Example: Reprehenderit maiores possimus illo.

line_item_values   string   

The data of the line item. Example : {"price": [100, 100]} Example: quia

Patch

requires authentication

Update a line item.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"minima\",
    \"description\": \"Non dignissimos qui aspernatur quia quo velit.\",
    \"line_item_values\": \"nihil\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'minima',
            'description' => 'Non dignissimos qui aspernatur quia quo velit.',
            'line_item_values' => 'nihil',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "minima",
    "description": "Non dignissimos qui aspernatur quia quo velit.",
    "line_item_values": "nihil"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/line-items/{lineItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

lineItem_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the line item. Example : "Termite Pesticide" Example: minima

description   string  optional  

The description of the line item. Example : "Termite Pesticide" Example: Non dignissimos qui aspernatur quia quo velit.

line_item_values   string   

The data of the line item. Example : {"price": [100, 100]} Example: nihil

Delete

requires authentication

Delete a line item.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/line-items/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/line-items/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/line-items/{lineItem_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

lineItem_uuid   integer   

Example: 1

List

requires authentication

Shows the list of teams with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/teams" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/teams';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/teams"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/teams

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 17

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 1

sort_by   string  optional  

The column name. Example : name Example: laborum

sort_order   string  optional  

The order in which you want your records. Example : asc Example: voluptate

search   string  optional  

The general search, it will find matching string. Example : home Example: et

Show

requires authentication

Show a single team.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/teams/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/teams/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/teams/{team_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

team_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created team.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/teams" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"non\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/teams';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'non',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/teams"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "non"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/teams

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the team. Example : "Engineering" Example: non

Update

requires authentication

Update a team.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"accusantium\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/teams/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'accusantium',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "accusantium"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/teams/{team_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

team_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the team. Example : "Accounting" Example: accusantium

Patch

requires authentication

Patch a company team.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ab\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/teams/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'ab',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "ab"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/teams/{team_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

team_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the team. Example : "Accounting" Example: ab

Delete

requires authentication

Delete a team.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/teams/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/teams/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/teams/{team_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

team_uuid   integer   

Example: 1

List

requires authentication

Returns the list of available reports

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports/templates" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/templates';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/templates"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports/templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 13

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 16

sort_by   string  optional  

The column name. Example : title Example: commodi

sort_order   string  optional  

The order in which you want your records. Example : asc Example: dicta

search   string  optional  

The general search, it will find matching string. Example : home Example: et

filter_by_uuids   string  optional  

string[] To fitler by selected uuids. Example : [uuid, uuid-2] Example: molestiae

groups   string  optional  

string[] To fitler by selected groups. Example : [dashboard, sales] Example: et

uuid   string  optional  

optional The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update

requires authentication

Update a report template.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/reports/templates/a6796d15-0b31-33a5-a1b3-6d3b2b2aed53" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/templates/a6796d15-0b31-33a5-a1b3-6d3b2b2aed53';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/templates/a6796d15-0b31-33a5-a1b3-6d3b2b2aed53"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/v1/reports/templates/{reportTemplate_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reportTemplate_uuid   string   

Example: a6796d15-0b31-33a5-a1b3-6d3b2b2aed53

Delete

requires authentication

Delete a report template.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/reports/templates/a681dfa6-cd2d-30b8-953b-8a7233b5876a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/templates/a681dfa6-cd2d-30b8-953b-8a7233b5876a';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/templates/a681dfa6-cd2d-30b8-953b-8a7233b5876a"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/reports/templates/{reportTemplate_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

reportTemplate_uuid   string   

Example: a681dfa6-cd2d-30b8-953b-8a7233b5876a

List

requires authentication

Shows the list of webhooks.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/webhooks/subscribe" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/webhooks/subscribe';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/webhooks/subscribe"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/webhooks/subscribe

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 10

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 11

sort_by   string  optional  

The column name. Example : name Example: quod

sort_order   string  optional  

The order in which you want your records. Example : asc Example: enim

search   string  optional  

The general search, it will find matching string. Example : home Example: accusamus

Store

requires authentication

Save new webhook subscription

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/webhooks/subscribe" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"url\": \"\'http:\\/\\/zapier.com\\/customer-created-in-smarterlaunch\'\",
    \"event\": \"customer-create\'\",
    \"type\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/webhooks/subscribe';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'url' => '\'http://zapier.com/customer-created-in-smarterlaunch\'',
            'event' => 'customer-create\'',
            'type' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/webhooks/subscribe"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "url": "'http:\/\/zapier.com\/customer-created-in-smarterlaunch'",
    "event": "customer-create'",
    "type": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/webhooks/subscribe

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

url   string   

The url where smarterlaunch submit data when particular events are triggered. Example: 'http://zapier.com/customer-created-in-smarterlaunch'

event   string   

To determine what kind of trigger the webhook is for. Example: customer-create'

type   boolean   

Check To determine what integration the incoming webhook is for. Example: true

Delete

requires authentication

Delete a webhook.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/webhooks/subscribe/6a1bcf97-5f38-3ddc-aeb9-d665071a3a77" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/webhooks/subscribe/6a1bcf97-5f38-3ddc-aeb9-d665071a3a77';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/webhooks/subscribe/6a1bcf97-5f38-3ddc-aeb9-d665071a3a77"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/webhooks/subscribe/{webhook_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

webhook_uuid   string   

Example: 6a1bcf97-5f38-3ddc-aeb9-d665071a3a77

User

API for user details

List / Fetch

requires authentication

Shows the list of users or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string  optional  

optional The uuid of the user. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

List / Fetch

requires authentication

Shows the list of users or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/users/{user_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Body Parameters

uuid   string  optional  

optional The uuid of the user. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Store user profile pic.

requires authentication

This endpoint lets user to upload or update profile picture.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/users/3/image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "uuid=3245d630-24fd-11ec-accd-e397aec85c7f"\
    --form "profile_photo_url=@/tmp/php6pV304" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3/image';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'uuid',
                'contents' => '3245d630-24fd-11ec-accd-e397aec85c7f'
            ],
            [
                'name' => 'profile_photo_url',
                'contents' => fopen('/tmp/php6pV304', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3/image"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('uuid', '3245d630-24fd-11ec-accd-e397aec85c7f');
body.append('profile_photo_url', document.querySelector('input[name="profile_photo_url"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/users/{user_uuid}/image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Body Parameters

profile_photo_url   file   

The image file. Example: /tmp/php6pV304

uuid   string   

The user uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Store user signature pic.

requires authentication

This endpoint lets user to upload or update signature picture.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/users/3/signature-image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "uuid=3245d630-24fd-11ec-accd-e397aec85c7f"\
    --form "signature_photo_url=@/tmp/phpgbyq82" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3/signature-image';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'uuid',
                'contents' => '3245d630-24fd-11ec-accd-e397aec85c7f'
            ],
            [
                'name' => 'signature_photo_url',
                'contents' => fopen('/tmp/phpgbyq82', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3/signature-image"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('uuid', '3245d630-24fd-11ec-accd-e397aec85c7f');
body.append('signature_photo_url', document.querySelector('input[name="signature_photo_url"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/users/{user_uuid}/signature-image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Body Parameters

signature_photo_url   file   

The image file. Example: /tmp/phpgbyq82

uuid   string   

The user uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Create / Update.

requires authentication

This endpoint lets user to create or update single record using uuid

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "uuid=3245d630-24fd-11ec-accd-e397aec85c7f"\
    --form "first_name=John"\
    --form "last_name=Smith"\
    --form "phone=7897897894"\
    --form "email=hello@smarterlaunch.com"\
    --form "position=Manager"\
    --form "new_password=XXX"\
    --form "confirm_new_password=XTXT"\
    --form "profile_photo_url=@/tmp/phpqvkjF4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'uuid',
                'contents' => '3245d630-24fd-11ec-accd-e397aec85c7f'
            ],
            [
                'name' => 'first_name',
                'contents' => 'John'
            ],
            [
                'name' => 'last_name',
                'contents' => 'Smith'
            ],
            [
                'name' => 'phone',
                'contents' => '7897897894'
            ],
            [
                'name' => 'email',
                'contents' => 'hello@smarterlaunch.com'
            ],
            [
                'name' => 'position',
                'contents' => 'Manager'
            ],
            [
                'name' => 'new_password',
                'contents' => 'XXX'
            ],
            [
                'name' => 'confirm_new_password',
                'contents' => 'XTXT'
            ],
            [
                'name' => 'profile_photo_url',
                'contents' => fopen('/tmp/phpqvkjF4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('uuid', '3245d630-24fd-11ec-accd-e397aec85c7f');
body.append('first_name', 'John');
body.append('last_name', 'Smith');
body.append('phone', '7897897894');
body.append('email', 'hello@smarterlaunch.com');
body.append('position', 'Manager');
body.append('new_password', 'XXX');
body.append('confirm_new_password', 'XTXT');
body.append('profile_photo_url', document.querySelector('input[name="profile_photo_url"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/users

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

uuid   string  optional  

optional The document uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

first_name   string   

The first name of the customer. Example: John

last_name   string   

The last name of the customer. Example: Smith

phone   string   

The phone of the customer. Example: 7897897894

email   string  optional  

optional The email of the customer. Example: hello@smarterlaunch.com

position   string   

The position of the customer. Example: Manager

new_password   string  optional  

optional The current password of the customer. Example: XXX

confirm_new_password   string  optional  

optional The confirmation of the new password of the customer. Example: XTXT

profile_photo_url   file  optional  

optional The image file. Example: /tmp/phpqvkjF4

Create / Update.

requires authentication

This endpoint lets user to create or update single record using uuid

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "uuid=3245d630-24fd-11ec-accd-e397aec85c7f"\
    --form "first_name=John"\
    --form "last_name=Smith"\
    --form "phone=7897897894"\
    --form "email=hello@smarterlaunch.com"\
    --form "position=Manager"\
    --form "new_password=XXX"\
    --form "confirm_new_password=XTXT"\
    --form "profile_photo_url=@/tmp/phpEb3pR4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'uuid',
                'contents' => '3245d630-24fd-11ec-accd-e397aec85c7f'
            ],
            [
                'name' => 'first_name',
                'contents' => 'John'
            ],
            [
                'name' => 'last_name',
                'contents' => 'Smith'
            ],
            [
                'name' => 'phone',
                'contents' => '7897897894'
            ],
            [
                'name' => 'email',
                'contents' => 'hello@smarterlaunch.com'
            ],
            [
                'name' => 'position',
                'contents' => 'Manager'
            ],
            [
                'name' => 'new_password',
                'contents' => 'XXX'
            ],
            [
                'name' => 'confirm_new_password',
                'contents' => 'XTXT'
            ],
            [
                'name' => 'profile_photo_url',
                'contents' => fopen('/tmp/phpEb3pR4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('uuid', '3245d630-24fd-11ec-accd-e397aec85c7f');
body.append('first_name', 'John');
body.append('last_name', 'Smith');
body.append('phone', '7897897894');
body.append('email', 'hello@smarterlaunch.com');
body.append('position', 'Manager');
body.append('new_password', 'XXX');
body.append('confirm_new_password', 'XTXT');
body.append('profile_photo_url', document.querySelector('input[name="profile_photo_url"]').files[0]);

fetch(url, {
    method: "PUT",
    headers,
    body,
}).then(response => response.json());

Request      

PUT api/v1/users/{user_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Body Parameters

uuid   string  optional  

optional The document uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

first_name   string   

The first name of the customer. Example: John

last_name   string   

The last name of the customer. Example: Smith

phone   string   

The phone of the customer. Example: 7897897894

email   string  optional  

optional The email of the customer. Example: hello@smarterlaunch.com

position   string   

The position of the customer. Example: Manager

new_password   string  optional  

optional The current password of the customer. Example: XXX

confirm_new_password   string  optional  

optional The confirmation of the new password of the customer. Example: XTXT

profile_photo_url   file  optional  

optional The image file. Example: /tmp/phpEb3pR4

Patch

requires authentication

This endpoint allows users to patch their user info.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_name\": \"John\",
    \"last_name\": \"Smith\",
    \"phone\": \"7897897894\",
    \"position\": \"Manager\",
    \"settings\": [
        \"suscipit\"
    ],
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'first_name' => 'John',
            'last_name' => 'Smith',
            'phone' => '7897897894',
            'position' => 'Manager',
            'settings' => [
                'suscipit',
            ],
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "first_name": "John",
    "last_name": "Smith",
    "phone": "7897897894",
    "position": "Manager",
    "settings": [
        "suscipit"
    ],
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/users/{user_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Body Parameters

first_name   string  optional  

optional The first name of the user. Example: John

last_name   string  optional  

optional The last name of the user. Example: Smith

phone   string  optional  

optional The phone of the user. Example: 7897897894

position   string  optional  

optional The position of the user. Example: Manager

settings   string[]  optional  

optional The user settings.
dark_theme   boolean  optional  

optional The dark theme setting. Example: true

integrations   string[]  optional  

optional The user integrations settings.
isn   string[]  optional  

optional The ISN integration settings.

wisetack   string[]  optional  

optional The Wisetack integration settings.

uuid   string   

The user uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Remove Profile pic.

requires authentication

This endpoint allows users to remove profile pictures with proper authorization.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/users/image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/image';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/image"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/users/image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Remove Profile pic.

requires authentication

This endpoint allows users to remove profile pictures with proper authorization.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/users/3/image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3/image';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3/image"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/users/{user_uuid}/image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Delete

requires authentication

This end point allows user to delete the user-account.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/users/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/users/3';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/users/3"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

DELETE api/v1/users/{user_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

user_uuid   integer   

Example: 3

Body Parameters

uuid   string   

The uuid of the user. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Company Location Custom Settings

API for company location custom settings

List

requires authentication

Shows the list of do with filter or single template page data.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page_size\": 15,
    \"sort_by\": \"title\",
    \"sort_order\": \"asc\",
    \"search\": \"John\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-settings';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'page' => '1',
        ],
        'json' => [
            'page_size' => 15,
            'sort_by' => 'title',
            'sort_order' => 'asc',
            'search' => 'John',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings"
);

const params = {
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "page_size": 15,
    "sort_by": "title",
    "sort_order": "asc",
    "search": "John"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/custom-settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Query Parameters

page   integer  optional  

optional The page number. Example: 1

Body Parameters

page_size   integer  optional  

optional The number of records you want per page. Example: 15

sort_by   string  optional  

optional The column name. Example: title

sort_order   string  optional  

optional The order in which you want your records. Example: asc

search   string  optional  

optional The general search, it will find matching string. Example: John

Show

requires authentication

Show detail of a company location setting

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/f2ce4b6f-dc87-3641-bf76-a4141acab83f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/f2ce4b6f-dc87-3641-bf76-a4141acab83f';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/f2ce4b6f-dc87-3641-bf76-a4141acab83f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/custom-settings/{companyLocationCustomSetting_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocationCustomSetting_uuid   string   

Example: f2ce4b6f-dc87-3641-bf76-a4141acab83f

companyUuid   string  optional  

Uuid of Company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyLocationCustomSettingUuid   string  optional  

Uuid of CompanyLocationCustomSetting. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Create

requires authentication

Create a company location custom setting

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Services\",
    \"value\": \"Pest control\",
    \"company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-settings';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Services',
            'value' => 'Pest control',
            'company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Services",
    "value": "Pest control",
    "company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/custom-settings

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyUuid   string  optional  

Uuid of Company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of custom setting. Example: Services

value   string   

The value of custom setting. Example: Pest control

company_location_uuid   string  optional  

option The specific company location uuid of the custom setting. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update

requires authentication

Update a company location custom setting

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/2aae83b2-89c8-328b-a255-07c840f0716f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Services\",
    \"value\": \"Pest control\",
    \"company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/2aae83b2-89c8-328b-a255-07c840f0716f';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Services',
            'value' => 'Pest control',
            'company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/2aae83b2-89c8-328b-a255-07c840f0716f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Services",
    "value": "Pest control",
    "company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/custom-settings/{companyLocationCustomSetting_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocationCustomSetting_uuid   string   

Example: 2aae83b2-89c8-328b-a255-07c840f0716f

companyUuid   string  optional  

Uuid of Company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyLocationCustomSettingUuid   string  optional  

Uuid of CompanyLocationCustomSetting. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

name   string   

The name of custom setting. Example: Services

value   string   

The value of custom setting. Example: Pest control

company_location_uuid   string  optional  

option The specific company location uuid of the custom setting. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Delete

requires authentication

Deletes a company location custom setting

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/78fb3156-a489-35e9-bb66-e05f4d13753f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/78fb3156-a489-35e9-bb66-e05f4d13753f';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-settings/78fb3156-a489-35e9-bb66-e05f4d13753f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/custom-settings/{companyLocationCustomSetting_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

companyLocationCustomSetting_uuid   string   

Example: 78fb3156-a489-35e9-bb66-e05f4d13753f

companyUuid   string  optional  

Uuid of Company. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

companyLocationCustomSettingUuid   string  optional  

Uuid of CompanyLocationCustomSetting. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Import Type

API for Import Type

List

requires authentication

Shows the list of tags with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/import-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/import-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 16

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 13

sort_by   string  optional  

The column name. Example : name Example: laborum

sort_order   string  optional  

The order in which you want your records. Example : asc Example: qui

search   string  optional  

The general search, it will find matching string. Example : "Categories" Example: ab

name   string  optional  

The name of import type. Example : "Categories" Example: quidem

code   string  optional  

The code of import type. Example : "categories" Example: aperiam

Proposal

API for Proposal

Get

requires authentication

Display the selected proposal.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/preview" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/preview';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/preview"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/preview

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Get client IP Address and Date time prior to accepting the proposal

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/get-ip-datetime" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/get-ip-datetime';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/get-ip-datetime"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/get-ip-datetime

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Store Proposal Inquiry

requires authentication

Send inquiry request from users

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/support-request" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"support_type\": \"\'General Inquiry\'\",
    \"screenshots_url\": [
        \"https:\\/\\/example.net\\/image1.jpg\",
        \"https:\\/\\/example.net\\/image1.png\"
    ],
    \"description\": \"\'I cannot access documents. Please help.\'\",
    \"no_attachments\": false
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/support-request';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'support_type' => '\'General Inquiry\'',
            'screenshots_url' => [
                'https://example.net/image1.jpg',
                'https://example.net/image1.png',
            ],
            'description' => '\'I cannot access documents. Please help.\'',
            'no_attachments' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/support-request"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "support_type": "'General Inquiry'",
    "screenshots_url": [
        "https:\/\/example.net\/image1.jpg",
        "https:\/\/example.net\/image1.png"
    ],
    "description": "'I cannot access documents. Please help.'",
    "no_attachments": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/support-request

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

support_type   string   

The support type. Example: 'General Inquiry'

client_detail   object  optional  
screenshots_url   string[]   

The screenshots URL string.

description   string   

The support request details. Example: 'I cannot access documents. Please help.'

no_attachments   boolean   

Check if request has attachments. Example: false

Upload

requires authentication

Upload photos for Cover Letter or Photo Layout pages

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/396e5080-914f-3062-b479-d3c866a3c47c/support-request-upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"screenshot_url\": \"https:\\/\\/example.net\\/test.png\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/396e5080-914f-3062-b479-d3c866a3c47c/support-request-upload';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'screenshot_url' => 'https://example.net/test.png',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/396e5080-914f-3062-b479-d3c866a3c47c/support-request-upload"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "screenshot_url": "https:\/\/example.net\/test.png"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/{supportRequestUuid}/support-request-upload

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

supportRequestUuid   string   

Example: 396e5080-914f-3062-b479-d3c866a3c47c

Body Parameters

screenshot_url   string   

The url of the attached image. Example: https://example.net/test.png

Accept and Sign

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/accept-sign" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"signature_photo_url\": \"http:\\/\\/www.braun.biz\\/est-ea-aut-reiciendis-culpa-asperiores-ipsa-vitae-et\",
    \"proposal_pdf_url\": \"https:\\/\\/price.com\\/voluptatem-eos-vero-voluptatem-voluptas-aliquid-sunt-qui-itaque.html\",
    \"auth_code\": \"eos\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/accept-sign';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'signature_photo_url' => 'http://www.braun.biz/est-ea-aut-reiciendis-culpa-asperiores-ipsa-vitae-et',
            'proposal_pdf_url' => 'https://price.com/voluptatem-eos-vero-voluptatem-voluptas-aliquid-sunt-qui-itaque.html',
            'auth_code' => 'eos',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/accept-sign"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "signature_photo_url": "http:\/\/www.braun.biz\/est-ea-aut-reiciendis-culpa-asperiores-ipsa-vitae-et",
    "proposal_pdf_url": "https:\/\/price.com\/voluptatem-eos-vero-voluptatem-voluptas-aliquid-sunt-qui-itaque.html",
    "auth_code": "eos"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/accept-sign

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

accepted_confirmation_uuids   object  optional  
signature_photo_url   string   

The image url. Example: http://www.braun.biz/est-ea-aut-reiciendis-culpa-asperiores-ipsa-vitae-et

proposal_pdf_url   string   

The pdf file url. Example: https://price.com/voluptatem-eos-vero-voluptatem-voluptas-aliquid-sunt-qui-itaque.html

auth_code   string  optional  

Example: eos

Replicate Signature

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/replace-signature" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"signature_photo_url\": \"http:\\/\\/www.wyman.com\\/qui-et-est-aperiam-quo-enim.html\",
    \"proposal_pdf_url\": \"http:\\/\\/www.stoltenberg.biz\\/\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/replace-signature';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'signature_photo_url' => 'http://www.wyman.com/qui-et-est-aperiam-quo-enim.html',
            'proposal_pdf_url' => 'http://www.stoltenberg.biz/',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/replace-signature"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "signature_photo_url": "http:\/\/www.wyman.com\/qui-et-est-aperiam-quo-enim.html",
    "proposal_pdf_url": "http:\/\/www.stoltenberg.biz\/"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/replace-signature

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

signature_photo_url   string   

The image url. Example: http://www.wyman.com/qui-et-est-aperiam-quo-enim.html

proposal_pdf_url   string   

The pdf file url. Example: http://www.stoltenberg.biz/

Update Attached Document

requires authentication

Patch the specified proposal.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/update-attachment" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "documentIndex=3286686"\
    --form "documentFile=@/tmp/phpMDsgE1" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/update-attachment';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'documentIndex',
                'contents' => '3286686'
            ],
            [
                'name' => 'documentFile',
                'contents' => fopen('/tmp/phpMDsgE1', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/update-attachment"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('documentIndex', '3286686');
body.append('documentFile', document.querySelector('input[name="documentFile"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/update-attachment

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

documentFile   file  optional  

The updated document file. Example : WDIIR.pdf Example: /tmp/phpMDsgE1

documentIndex   number  optional  

The document index number. Example : 1 Example: 3286686

Log Video Clicked

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/video-clicked" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"video_type\": \"atque\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/video-clicked';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'video_type' => 'atque',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/video-clicked"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "video_type": "atque"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/video-clicked

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

video_type   'service'  optional  

| 'screen_recording' Example: atque

Decline

requires authentication

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/decline" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/decline';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/decline"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/decline

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Update Selected Pricing

requires authentication

Patch the specified proposal.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/update-selected-pricing" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"proposal_values\": []
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/update-selected-pricing';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'proposal_values' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/update-selected-pricing"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "proposal_values": []
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/update-selected-pricing

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

proposal_values   object  optional  

The collected data of the proposal in object format. Example : {"price":1000.00,"currency":"$"}

Submit Customer Forms

requires authentication

Patch the specified proposal.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/customer-forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"formValues\": [],
    \"submittedForms\": [],
    \"proposal_values\": []
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/customer-forms';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'formValues' => [],
            'submittedForms' => [],
            'proposal_values' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/customer-forms"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "formValues": [],
    "submittedForms": [],
    "proposal_values": []
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/customer-forms

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

formValues   object   
attachedDocuments   object  optional  
submittedForms   object   
proposal_values   object  optional  

The collected data of the proposal in object format. Example : {"price":1000.00,"currency":"$"}

List

requires authentication

Shows the list of proposal with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ignore_cached\": true,
    \"date_range_start\": \"2025-11-07T04:29:22\",
    \"date_range_end\": \"2091-01-03\",
    \"timezone\": \"Atlantic\\/South_Georgia\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'ignore_cached' => true,
            'date_range_start' => '2025-11-07T04:29:22',
            'date_range_end' => '2091-01-03',
            'timezone' => 'Atlantic/South_Georgia',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "ignore_cached": true,
    "date_range_start": "2025-11-07T04:29:22",
    "date_range_end": "2091-01-03",
    "timezone": "Atlantic\/South_Georgia"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/proposals

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 12

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 1

sort_by   string  optional  

The column name. Example : name Example: explicabo

sort_order   string  optional  

The order in which you want your records. Example : asc Example: nihil

search   string  optional  

The general search, it will find matching string. Example : home Example: perspiciatis

search_by   string  optional  

The specific field to search within. Options: customer_name, title, description. Example : customer_name Example: nemo

company_location_uuid   string  optional  

The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 18a55eb7-ee38-3c78-8112-c37dc20212cf

company_location_uuids   string  optional  

string[] The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: qui

status_uuid   string  optional  

string[] The UUID of proposal status. Example : ["815d3d9c-f371-3781-8456-7e6954b5b0f5"] Example: 255e7906-5692-38ae-a4be-57ae0740c132

customer_uuid   string  optional  

The UUID of a customer. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 84383c1c-4c3a-30b4-9a46-79b5ffc144cb

include_fields   string  optional  

string[] Optionally include related data for the proposal. Example : "company" Example: modi

user_uuid   string  optional  

Filter by the user that created proposals. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 7f518bf3-c271-367a-939a-99d79f0855a6

timezone   string  optional  

Optional timezone for date filtering. Falls back to user's favorite location timezone, then MST. Example : "America/New_York" Example: Asia/Pyongyang

date_range_start   string  optional  

Start date for filtering proposals. Example : "2024-08-01" Example: necessitatibus

date_range_end   string  optional  

End date for filtering proposals. Example : "2024-08-13" Example: quasi

date_range_type   string  optional  

Type of date to filter by. Options: created_at, updated_at. Example : "created_at" Example: dolorum

Body Parameters

include_fields   string[]  optional  
ignore_cached   boolean  optional  

Example: true

date_range_start   string  optional  

Must be a valid date. Example: 2025-11-07T04:29:22

date_range_end   string  optional  

Must be a valid date. Must be a date after or equal to date_range_start. Example: 2091-01-03

timezone   string  optional  

Must be a valid time zone, such as Africa/Accra. Example: Atlantic/South_Georgia

Export List

requires authentication

Returns a CSV file of list of filtered proposal list.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/export-list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/export-list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/export-list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/export-list

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 11

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 12

sort_by   string  optional  

The column name. Example : name Example: hic

sort_order   string  optional  

The order in which you want your records. Example : asc Example: deleniti

search   string  optional  

The general search, it will find matching string. Example : home Example: quis

company_location_uuid   string  optional  

The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 9e3b19c1-2334-3198-8883-bd32c8e8c8e0

company_location_uuids   string  optional  

string[] The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: doloribus

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0d9068ea-be89-3584-ab0c-4d9e29320891

customer_uuid   string  optional  

The UUID of a customer. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: a1d1621e-9ee1-3e1a-afa5-a60fb78bc36f

include_fields   string  optional  

string[] Optionally include related data for the proposal. Example : "company" Example: provident

user_uuid   string  optional  

Filter by the user that created proposals. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: a121f021-a977-3e19-88d1-944d1fb4b1ac

Summary

requires authentication

Shows the summary of proposal. Returns number of items per Proposal status.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/summary" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/summary';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/summary"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/summary

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Get

requires authentication

Display the selected proposal.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/{proposal_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

List of Activity Logs

requires authentication

Shows the list of proposal's activity logs with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/{proposal_uuid}/activity-logs

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

page   integer  optional  

The page number. Example : 1 Example: 1

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 2

sort_by   string  optional  

The column name. Example : name Example: error

sort_order   string  optional  

The order in which you want your records. Example : asc Example: rerum

search   string  optional  

The general search, it will find matching string. Example : home Example: sunt

Body Parameters

include_fields   object  optional  

Get the events associated with a specific proposal activity

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/15/activity/0842b22b-59cf-3baa-b6b9-3a77da69521a/events" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/activity/0842b22b-59cf-3baa-b6b9-3a77da69521a/events';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity/0842b22b-59cf-3baa-b6b9-3a77da69521a/events"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/{proposal_uuid}/activity/{activity_uuid}/events

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

activity_uuid   string   

Example: 0842b22b-59cf-3baa-b6b9-3a77da69521a

Download TARF XML

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/15/tarf-xml-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/tarf-xml-url';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/tarf-xml-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/{proposal_uuid}/tarf-xml-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Download California WDO XML

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/15/cali-wdo-report-url" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/cali-wdo-report-url';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/cali-wdo-report-url"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/proposals/{proposal_uuid}/cali-wdo-report-url

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Create

requires authentication

Store a newly created proposal activity entry

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Be sure to follow-up with the customer.\'\",
    \"remind_at\": \"07\\/23\\/2024\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'Be sure to follow-up with the customer.\'',
            'remind_at' => '07/23/2024',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "Be sure to follow-up with the customer.'",
    "remind_at": "07\/23\/2024"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/proposals/{proposal_uuid}/activity-logs

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

description   string   

The description of activity entry. Example: Be sure to follow-up with the customer.'

remind_at   string   

The date of reminder through email. Example: 07/23/2024

action

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/8e9b4538-ff43-350b-99d1-1ae59dbb42dc/id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/8e9b4538-ff43-350b-99d1-1ae59dbb42dc/id';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/8e9b4538-ff43-350b-99d1-1ae59dbb42dc/id"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/proposals/{proposal_uuid}/activity-logs/{activityEntryUuid}/{action}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

activityEntryUuid   string   

Example: 8e9b4538-ff43-350b-99d1-1ae59dbb42dc

action   string   

Example: id

Create

requires authentication

Store a newly created proposal.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"quod\",
    \"description\": \"Sunt officia accusantium et labore itaque voluptatum sequi.\",
    \"company_location_uuid\": \"fb50a6ac-6619-35d4-848d-7ea65bb614a5\",
    \"customer_uuid\": \"0407d87c-ed6d-3484-b911-44450d323c32\",
    \"customer_address_uuid\": \"c2bf3324-5ee7-3547-b881-ba11fa29fc03\",
    \"status_uuid\": \"5e2a931f-5717-3098-b488-bd2b70f4020a\",
    \"service_plan_uuids\": [
        \"quo\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"6f323e79-3ff8-3f67-b490-495e6852a41b\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'quod',
            'description' => 'Sunt officia accusantium et labore itaque voluptatum sequi.',
            'company_location_uuid' => 'fb50a6ac-6619-35d4-848d-7ea65bb614a5',
            'customer_uuid' => '0407d87c-ed6d-3484-b911-44450d323c32',
            'customer_address_uuid' => 'c2bf3324-5ee7-3547-b881-ba11fa29fc03',
            'status_uuid' => '5e2a931f-5717-3098-b488-bd2b70f4020a',
            'service_plan_uuids' => [
                'quo',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => '6f323e79-3ff8-3f67-b490-495e6852a41b',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "quod",
    "description": "Sunt officia accusantium et labore itaque voluptatum sequi.",
    "company_location_uuid": "fb50a6ac-6619-35d4-848d-7ea65bb614a5",
    "customer_uuid": "0407d87c-ed6d-3484-b911-44450d323c32",
    "customer_address_uuid": "c2bf3324-5ee7-3547-b881-ba11fa29fc03",
    "status_uuid": "5e2a931f-5717-3098-b488-bd2b70f4020a",
    "service_plan_uuids": [
        "quo"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "6f323e79-3ff8-3f67-b490-495e6852a41b"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/proposals

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

title   string   

The title of the proposal. Example : Pest Route Initial Proposal Example: quod

description   string  optional  

The paragraph describing the proposal. Example: Sunt officia accusantium et labore itaque voluptatum sequi.

company_location_uuid   string   

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: fb50a6ac-6619-35d4-848d-7ea65bb614a5

customer_uuid   string   

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0407d87c-ed6d-3484-b911-44450d323c32

customer_address_uuid   string   

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: c2bf3324-5ee7-3547-b881-ba11fa29fc03

status_uuid   string   

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 5e2a931f-5717-3098-b488-bd2b70f4020a

service_plan_uuids   string[]  optional  

The list of ServicePlan's UUID you want to add in the proposal. Example : ["815d3d9c-f371-3781-8456-7e6954b5b0f5", "815d3d9c-f371-3781-8456-7e6954b5b0f5"]

proposal_values   object  optional  

The collected data of the proposal in object format. Example : {"price":1000.00,"currency":"$"}

proposal_template_uuid   string   

The UUID of proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 6f323e79-3ff8-3f67-b490-495e6852a41b

Duplicate

requires authentication

This endpoint lets user to duplicate proposal and set into a draft mode

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/3245d630-24fd-11ec-accd-e397aec85c7f/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/3245d630-24fd-11ec-accd-e397aec85c7f/duplicate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/3245d630-24fd-11ec-accd-e397aec85c7f/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/proposals/{proposal_uuid}/duplicate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   string  optional  

uuid required The uuid of the proposal. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Upload Review Photo

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/15/upload-review-photo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "type='cover'."\
    --form "layout='Tiled'."\
    --form "photo=@/tmp/phppRKTx4" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/upload-review-photo';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'type',
                'contents' => ''cover'.'
            ],
            [
                'name' => 'layout',
                'contents' => ''Tiled'.'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/phppRKTx4', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/upload-review-photo"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('type', ''cover'.');
body.append('layout', ''Tiled'.');
body.append('photo', document.querySelector('input[name="photo"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/proposals/{proposal_uuid}/upload-review-photo

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

photo   file   

The image file. Example: /tmp/phppRKTx4

type   enum  optional  

'cover' | 'photos' required The photo type. Example: 'cover'.

layout   enum  optional  

'Tiled' | 'Stacked' required The photo type. Example: 'Tiled'.

Resync document

requires authentication

Resync document the specified proposal.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/proposals/15/push-to-crm" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"voluptas\",
    \"description\": \"Asperiores qui nemo est fugiat reprehenderit est et.\",
    \"company_location_uuid\": \"6d02d659-531a-388f-9033-82ba81ef0ebb\",
    \"customer_uuid\": \"8eb2b9fc-2a20-398c-8254-ae5d802adf01\",
    \"customer_address_uuid\": \"2d9a62ee-4af4-3b3d-a0e2-da3c31ff4d23\",
    \"status_uuid\": \"180d4272-1b10-3c23-b7c0-39f44ce2e6f0\",
    \"service_plan_uuids\": [
        \"sunt\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"f27495d7-b1d8-3cde-81ce-df8017b5ef74\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/push-to-crm';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'voluptas',
            'description' => 'Asperiores qui nemo est fugiat reprehenderit est et.',
            'company_location_uuid' => '6d02d659-531a-388f-9033-82ba81ef0ebb',
            'customer_uuid' => '8eb2b9fc-2a20-398c-8254-ae5d802adf01',
            'customer_address_uuid' => '2d9a62ee-4af4-3b3d-a0e2-da3c31ff4d23',
            'status_uuid' => '180d4272-1b10-3c23-b7c0-39f44ce2e6f0',
            'service_plan_uuids' => [
                'sunt',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => 'f27495d7-b1d8-3cde-81ce-df8017b5ef74',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/push-to-crm"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "voluptas",
    "description": "Asperiores qui nemo est fugiat reprehenderit est et.",
    "company_location_uuid": "6d02d659-531a-388f-9033-82ba81ef0ebb",
    "customer_uuid": "8eb2b9fc-2a20-398c-8254-ae5d802adf01",
    "customer_address_uuid": "2d9a62ee-4af4-3b3d-a0e2-da3c31ff4d23",
    "status_uuid": "180d4272-1b10-3c23-b7c0-39f44ce2e6f0",
    "service_plan_uuids": [
        "sunt"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "f27495d7-b1d8-3cde-81ce-df8017b5ef74"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/proposals/{proposal_uuid}/push-to-crm

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

title   string  optional  

The title of the proposal. Example : Pest Route Initial Proposal Example: voluptas

description   string  optional  

The paragraph describing the proposal. Example: Asperiores qui nemo est fugiat reprehenderit est et.

company_location_uuid   string  optional  

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 6d02d659-531a-388f-9033-82ba81ef0ebb

customer_uuid   string  optional  

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 8eb2b9fc-2a20-398c-8254-ae5d802adf01

customer_address_uuid   string  optional  

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 2d9a62ee-4af4-3b3d-a0e2-da3c31ff4d23

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 180d4272-1b10-3c23-b7c0-39f44ce2e6f0

service_plan_uuids   string[]  optional  

The list of ServicePlan's UUID you want to add in the proposal. Example : ['815d3d9c-f371-3781-8456-7e6954b5b0f5', '815d3d9c-f371-3781-8456-7e6954b5b0f5']

proposal_values   object  optional  

The collected data of the proposal in object format. Example : {"price":1000.00,"currency":"$"}

proposal_template_uuid   string   

The UUID of proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: f27495d7-b1d8-3cde-81ce-df8017b5ef74

Update

requires authentication

Updates the specified proposal.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"\\\"Pest Route Initial Proposal\\\"\",
    \"description\": \"\\\"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"company_location_uuid\": \"bd87c6d3-2e16-3120-8c9a-ccd1704207f1\",
    \"customer_uuid\": \"08816aed-7fef-39e1-8630-c43f13e912f8\",
    \"customer_address_uuid\": \"599fcb39-d08d-301e-b232-6263d799ff2c\",
    \"status_uuid\": \"82202bf3-f495-36f8-aca9-ef14f336f07b\",
    \"service_plan_uuids\": [
        \"qui\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"943c5fe8-c45b-36ca-8c3b-8a9cd589d738\",
    \"expire_at\": \"2025-11-07T04:29:22\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => '"Pest Route Initial Proposal"',
            'description' => '"Lorem, ipsum dolor sit amet consectetur adipisicing elit."',
            'company_location_uuid' => 'bd87c6d3-2e16-3120-8c9a-ccd1704207f1',
            'customer_uuid' => '08816aed-7fef-39e1-8630-c43f13e912f8',
            'customer_address_uuid' => '599fcb39-d08d-301e-b232-6263d799ff2c',
            'status_uuid' => '82202bf3-f495-36f8-aca9-ef14f336f07b',
            'service_plan_uuids' => [
                'qui',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => '943c5fe8-c45b-36ca-8c3b-8a9cd589d738',
            'expire_at' => '2025-11-07T04:29:22',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "\"Pest Route Initial Proposal\"",
    "description": "\"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"",
    "company_location_uuid": "bd87c6d3-2e16-3120-8c9a-ccd1704207f1",
    "customer_uuid": "08816aed-7fef-39e1-8630-c43f13e912f8",
    "customer_address_uuid": "599fcb39-d08d-301e-b232-6263d799ff2c",
    "status_uuid": "82202bf3-f495-36f8-aca9-ef14f336f07b",
    "service_plan_uuids": [
        "qui"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "943c5fe8-c45b-36ca-8c3b-8a9cd589d738",
    "expire_at": "2025-11-07T04:29:22"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/proposals/{proposal_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

title   string   

The title of the proposal. Example: "Pest Route Initial Proposal"

description   string  optional  

The paragraph describing the proposal. Example: "Lorem, ipsum dolor sit amet consectetur adipisicing elit."

company_location_uuid   string   

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: bd87c6d3-2e16-3120-8c9a-ccd1704207f1

customer_uuid   string   

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 08816aed-7fef-39e1-8630-c43f13e912f8

customer_address_uuid   string   

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 599fcb39-d08d-301e-b232-6263d799ff2c

status_uuid   string   

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 82202bf3-f495-36f8-aca9-ef14f336f07b

service_plan_uuids   string[]  optional  

The list of ServicePlan's UUID you want to add in the proposal. Example : ['815d3d9c-f371-3781-8456-7e6954b5b0f5', '815d3d9c-f371-3781-8456-7e6954b5b0f5']

proposal_values   object  optional  

The collected data of the proposal in object format. Example : {"price":1000.00,"currency":"$"}

settings   object  optional  
proposal_template_uuid   string   

The UUID of proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 943c5fe8-c45b-36ca-8c3b-8a9cd589d738

include_fields   object  optional  
expire_at   string  optional  

Must be a valid date. Example: 2025-11-07T04:29:22

Update

requires authentication

Update a proposal activity entry

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/f012618b-f753-3005-aea7-85fc2aa5afff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"description\": \"Be sure to follow-up with the customer.\'\",
    \"remind_at\": \"07\\/23\\/2024\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/f012618b-f753-3005-aea7-85fc2aa5afff';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'description' => 'Be sure to follow-up with the customer.\'',
            'remind_at' => '07/23/2024',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/f012618b-f753-3005-aea7-85fc2aa5afff"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "description": "Be sure to follow-up with the customer.'",
    "remind_at": "07\/23\/2024"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/proposals/{proposal_uuid}/activity-logs/{activityEntryUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

activityEntryUuid   string   

Example: f012618b-f753-3005-aea7-85fc2aa5afff

Body Parameters

description   string   

The description of activity entry. Example: Be sure to follow-up with the customer.'

remind_at   string   

The date of reminder through email. Example: 07/23/2024

Patch

requires authentication

Patch the specified proposal.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/proposals/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"temporibus\",
    \"description\": \"Omnis inventore voluptatem explicabo fugiat iure ab.\",
    \"company_location_uuid\": \"bacaf206-b3fa-3ab2-9b0b-0f183c0e8f43\",
    \"customer_uuid\": \"2f057dcf-090a-3142-8bdf-819d6e4be321\",
    \"customer_address_uuid\": \"47717a61-038c-35db-8c5a-649e3db503ec\",
    \"status_uuid\": \"f8de5daf-dd03-3a6a-b867-ae6fb40770f5\",
    \"service_plan_uuids\": [
        \"qui\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"e2c2b42b-8199-353b-a28c-6c700703b5a0\",
    \"expire_at\": \"2025-11-07T04:29:22\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'temporibus',
            'description' => 'Omnis inventore voluptatem explicabo fugiat iure ab.',
            'company_location_uuid' => 'bacaf206-b3fa-3ab2-9b0b-0f183c0e8f43',
            'customer_uuid' => '2f057dcf-090a-3142-8bdf-819d6e4be321',
            'customer_address_uuid' => '47717a61-038c-35db-8c5a-649e3db503ec',
            'status_uuid' => 'f8de5daf-dd03-3a6a-b867-ae6fb40770f5',
            'service_plan_uuids' => [
                'qui',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => 'e2c2b42b-8199-353b-a28c-6c700703b5a0',
            'expire_at' => '2025-11-07T04:29:22',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "temporibus",
    "description": "Omnis inventore voluptatem explicabo fugiat iure ab.",
    "company_location_uuid": "bacaf206-b3fa-3ab2-9b0b-0f183c0e8f43",
    "customer_uuid": "2f057dcf-090a-3142-8bdf-819d6e4be321",
    "customer_address_uuid": "47717a61-038c-35db-8c5a-649e3db503ec",
    "status_uuid": "f8de5daf-dd03-3a6a-b867-ae6fb40770f5",
    "service_plan_uuids": [
        "qui"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "e2c2b42b-8199-353b-a28c-6c700703b5a0",
    "expire_at": "2025-11-07T04:29:22"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/proposals/{proposal_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

title   string  optional  

The title of the proposal. Example : Pest Route Initial Proposal Example: temporibus

description   string  optional  

The paragraph describing the proposal. Example: Omnis inventore voluptatem explicabo fugiat iure ab.

company_location_uuid   string  optional  

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: bacaf206-b3fa-3ab2-9b0b-0f183c0e8f43

customer_uuid   string  optional  

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 2f057dcf-090a-3142-8bdf-819d6e4be321

customer_address_uuid   string  optional  

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 47717a61-038c-35db-8c5a-649e3db503ec

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: f8de5daf-dd03-3a6a-b867-ae6fb40770f5

service_plan_uuids   string[]  optional  

The list of ServicePlan's UUID you want to add in the proposal. Example : ['815d3d9c-f371-3781-8456-7e6954b5b0f5', '815d3d9c-f371-3781-8456-7e6954b5b0f5']

proposal_values   object  optional  

The collected data of the proposal in object format. Example : {"price":1000.00,"currency":"$"}

settings   object  optional  
proposal_template_uuid   string   

The UUID of proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: e2c2b42b-8199-353b-a28c-6c700703b5a0

include_fields   object  optional  
expire_at   string  optional  

Must be a valid date. Example: 2025-11-07T04:29:22

Share

requires authentication

Send proposal via email

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/proposals/15/share" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"recipients\": [
        \"johnsmith@example.net\",
        \"anasmith@example.net\"
    ],
    \"subject\": \"\\\"Pest Route Initial Proposal\\\"\",
    \"body\": \"\\\"Pest Route Initial Proposal\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/share';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'recipients' => [
                'johnsmith@example.net',
                'anasmith@example.net',
            ],
            'subject' => '"Pest Route Initial Proposal"',
            'body' => '"Pest Route Initial Proposal"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/share"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "recipients": [
        "johnsmith@example.net",
        "anasmith@example.net"
    ],
    "subject": "\"Pest Route Initial Proposal\"",
    "body": "\"Pest Route Initial Proposal\""
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/proposals/{proposal_uuid}/share

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

recipients   string[]   

The recipients of the proposal.

subject   string   

The subject of the proposal. Example: "Pest Route Initial Proposal"

body   string   

The body of the proposal. Example: "Pest Route Initial Proposal"

Delete

requires authentication

Delete a specified proposal.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/proposals/15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/proposals/{proposal_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Delete Review Photo

requires authentication

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/proposals/15/delete-review-photo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"image_url\": \"http:\\/\\/www.johnston.com\\/sit-laudantium-aut-qui-qui-quo.html\",
    \"type\": \"\'cover\'.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/delete-review-photo';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'image_url' => 'http://www.johnston.com/sit-laudantium-aut-qui-qui-quo.html',
            'type' => '\'cover\'.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/delete-review-photo"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "image_url": "http:\/\/www.johnston.com\/sit-laudantium-aut-qui-qui-quo.html",
    "type": "'cover'."
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

DELETE api/v1/proposals/{proposal_uuid}/delete-review-photo

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

Body Parameters

image_url   string   

The image url. Example: http://www.johnston.com/sit-laudantium-aut-qui-qui-quo.html

type   enum  optional  

'cover' | 'photos' required The photo type. Example: 'cover'.

Delete

requires authentication

Delete a proposal activity entry

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/7132e774-2a76-3588-8d14-9bb713e47f85" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/7132e774-2a76-3588-8d14-9bb713e47f85';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/7132e774-2a76-3588-8d14-9bb713e47f85"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/proposals/{proposal_uuid}/activity-logs/{activityEntryUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

proposal_uuid   integer   

Example: 15

activityEntryUuid   string   

Example: 7132e774-2a76-3588-8d14-9bb713e47f85

Service Agreement

API for service agreement details

List

requires authentication

Shows the list of company service agreements with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/service-agreements

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 9

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 5

sort_by   string  optional  

The column name. Example : title Example: sit

sort_order   string  optional  

The order in which you want your records. Example : asc Example: ullam

search   string  optional  

The general search, it will find matching string. Example : home Example: quo

filter_by_uuids   string  optional  

string[] To fitler by selected uuids. Example : [uuid, uuid-2] Example: esse

Show

requires authentication

Show a single service agreement.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/service-agreements/{serviceAgreement_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

serviceAgreement_uuid   integer   

Example: 1

Store

requires authentication

Store a service agreement.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"dicta\",
    \"content\": \"id\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'dicta',
            'content' => 'id',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "dicta",
    "content": "id"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/service-agreements

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

title   string   

The title of the service agreement. Example : Termites Service Agreement Example: dicta

content   string   

The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: id

Update

requires authentication

Update a service agreement.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"ea\",
    \"content\": \"architecto\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'ea',
            'content' => 'architecto',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "ea",
    "content": "architecto"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/service-agreements/{serviceAgreement_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

serviceAgreement_uuid   integer   

Example: 1

Body Parameters

title   string   

The title of the service agreement. Example : Termites Service Agreement Example: ea

content   string   

The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: architecto

Patch

requires authentication

Patch a service agreement.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"et\",
    \"content\": \"velit\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'et',
            'content' => 'velit',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "et",
    "content": "velit"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/service-agreements/{serviceAgreement_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

serviceAgreement_uuid   integer   

Example: 1

Body Parameters

title   string  optional  

optional The title of the service agreement. Example : Termites Service Agreement Example: et

content   string  optional  

optional The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: velit

Patch - Set as Active

requires authentication

Set as Active a service agreement version.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1/setAsActive" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"et\",
    \"content\": \"enim\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1/setAsActive';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'title' => 'et',
            'content' => 'enim',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1/setAsActive"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "title": "et",
    "content": "enim"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/service-agreements/{serviceAgreement_uuid}/setAsActive

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

serviceAgreement_uuid   integer   

Example: 1

Body Parameters

title   string  optional  

optional The title of the service agreement. Example : Termites Service Agreement Example: et

content   string  optional  

optional The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: enim

Delete

requires authentication

Delete a service agreement.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/service-agreements/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/service-agreements/{serviceAgreement_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

serviceAgreement_uuid   integer   

Example: 1

Company

API for company details

PATCH api/v1/companies/{company_uuid}/update-limit/{entity}

requires authentication

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/update-limit/ea" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/update-limit/ea';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/update-limit/ea"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/update-limit/{entity}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

entity   string   

Example: ea

List / Fetch.

requires authentication

Shows the list of company or fetch single record using uuid.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

uuid   string  optional  

optional The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Store company logo.

requires authentication

This endpoint lets company to upload or update their logo.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/image" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "image_url=@/tmp/phpv8fY20" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/image';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'image_url',
                'contents' => fopen('/tmp/phpv8fY20', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/image"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('image_url', document.querySelector('input[name="image_url"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/image

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

uuid   string   

The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

image_url   file   

The image file. Example: /tmp/phpv8fY20

Update Company

requires authentication

This endpoint lets user to update a company.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Smarter Launch\",
    \"phone\": \"5554448888\",
    \"email\": \"hello@smarterlaunch.com\",
    \"address1\": \"\'123 Smarter Launch Way\'\",
    \"address2\": \"\'Suite 101\'\",
    \"city\": \"Queen Creek\",
    \"country_state_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"country_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"postal_code\": \"85410\",
    \"latitude\": \"23.0396\",
    \"longitude\": \"72.566\",
    \"primary_color\": \"#009CFF\",
    \"secondary_color\": \"#FFFFFF\",
    \"settings\": [],
    \"image_url\": \"http:\\/\\/morar.net\\/architecto-iusto-voluptatem-illum-sunt-dolore-quidem\",
    \"company_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"description\": \"We are helping take your business to the next level. Hop in!\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Smarter Launch',
            'phone' => '5554448888',
            'email' => 'hello@smarterlaunch.com',
            'address1' => '\'123 Smarter Launch Way\'',
            'address2' => '\'Suite 101\'',
            'city' => 'Queen Creek',
            'country_state_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'country_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'postal_code' => '85410',
            'latitude' => '23.0396',
            'longitude' => '72.566',
            'primary_color' => '#009CFF',
            'secondary_color' => '#FFFFFF',
            'settings' => [],
            'image_url' => 'http://morar.net/architecto-iusto-voluptatem-illum-sunt-dolore-quidem',
            'company_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'description' => 'We are helping take your business to the next level. Hop in!',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Smarter Launch",
    "phone": "5554448888",
    "email": "hello@smarterlaunch.com",
    "address1": "'123 Smarter Launch Way'",
    "address2": "'Suite 101'",
    "city": "Queen Creek",
    "country_state_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "country_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "postal_code": "85410",
    "latitude": "23.0396",
    "longitude": "72.566",
    "primary_color": "#009CFF",
    "secondary_color": "#FFFFFF",
    "settings": [],
    "image_url": "http:\/\/morar.net\/architecto-iusto-voluptatem-illum-sunt-dolore-quidem",
    "company_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "description": "We are helping take your business to the next level. Hop in!"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the company. Example: Smarter Launch

phone   string   

The last name of the company. Example: 5554448888

email   string   

The email of the company. Example: hello@smarterlaunch.com

address1   string   

The address of the company. Example: '123 Smarter Launch Way'

address2   string  optional  

optional The address of the company. Example: 'Suite 101'

city   string   

The company city name. Example: Queen Creek

country_state_uuid   string   

The company state uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_uuid   string   

The company country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

postal_code   string  optional  

optional The postal code of the company. Example: 85410

latitude   string  optional  

optional The latitude of the company. Example: 23.0396

longitude   string  optional  

optional The longitude of the company. Example: 72.566

primary_color   string  optional  

optional The primary color. Example: #009CFF

secondary_color   string  optional  

optional The secondary color. Example: #FFFFFF

custom_settings   object  optional  
settings   object  optional  
available_integration_uuids   object  optional  
image_url   string  optional  

Example: http://morar.net/architecto-iusto-voluptatem-illum-sunt-dolore-quidem

company_uuid   string  optional  

optional The uuid of the company. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

description   string  optional  

optional The company description. Example: We are helping take your business to the next level. Hop in!

Patch Company

requires authentication

This endpoint lets user to update a company.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Smarter Launch\",
    \"phone\": \"5554448888\",
    \"email\": \"hello@smarterlaunch.com\",
    \"address1\": \"\'123 Smarter Launch Way\'\",
    \"address2\": \"\'Suite 101\'\",
    \"city\": \"Queen Creek\",
    \"country_state_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"country_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"postal_code\": \"85410\",
    \"latitude\": \"23.0396\",
    \"longitude\": \"72.566\",
    \"primary_color\": \"#009CFF\",
    \"secondary_color\": \"#FFFFFF\",
    \"settings\": [],
    \"website_url\": \"http:\\/\\/adams.biz\\/tempore-nostrum-qui-ullam-rerum.html\",
    \"google_my_business_listing\": \"http:\\/\\/www.rosenbaum.net\\/quasi-adipisci-non-qui-soluta-nobis\",
    \"image_url\": \"http:\\/\\/www.mosciski.com\\/et-corporis-doloribus-pariatur-fugiat-et-et-debitis.html\",
    \"company_uuid\": \"ecd24580-2749-11ec-9b86-1102c06e74b4\",
    \"description\": \"We are helping take your business to the next level. Hop in!\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Smarter Launch',
            'phone' => '5554448888',
            'email' => 'hello@smarterlaunch.com',
            'address1' => '\'123 Smarter Launch Way\'',
            'address2' => '\'Suite 101\'',
            'city' => 'Queen Creek',
            'country_state_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'country_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'postal_code' => '85410',
            'latitude' => '23.0396',
            'longitude' => '72.566',
            'primary_color' => '#009CFF',
            'secondary_color' => '#FFFFFF',
            'settings' => [],
            'website_url' => 'http://adams.biz/tempore-nostrum-qui-ullam-rerum.html',
            'google_my_business_listing' => 'http://www.rosenbaum.net/quasi-adipisci-non-qui-soluta-nobis',
            'image_url' => 'http://www.mosciski.com/et-corporis-doloribus-pariatur-fugiat-et-et-debitis.html',
            'company_uuid' => 'ecd24580-2749-11ec-9b86-1102c06e74b4',
            'description' => 'We are helping take your business to the next level. Hop in!',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Smarter Launch",
    "phone": "5554448888",
    "email": "hello@smarterlaunch.com",
    "address1": "'123 Smarter Launch Way'",
    "address2": "'Suite 101'",
    "city": "Queen Creek",
    "country_state_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "country_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "postal_code": "85410",
    "latitude": "23.0396",
    "longitude": "72.566",
    "primary_color": "#009CFF",
    "secondary_color": "#FFFFFF",
    "settings": [],
    "website_url": "http:\/\/adams.biz\/tempore-nostrum-qui-ullam-rerum.html",
    "google_my_business_listing": "http:\/\/www.rosenbaum.net\/quasi-adipisci-non-qui-soluta-nobis",
    "image_url": "http:\/\/www.mosciski.com\/et-corporis-doloribus-pariatur-fugiat-et-et-debitis.html",
    "company_uuid": "ecd24580-2749-11ec-9b86-1102c06e74b4",
    "description": "We are helping take your business to the next level. Hop in!"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

optional The name of the company. Example: Smarter Launch

phone   string  optional  

optional The last name of the company. Example: 5554448888

email   string  optional  

optional The email of the company. Example: hello@smarterlaunch.com

address1   string  optional  

optional The address of the company. Example: '123 Smarter Launch Way'

address2   string  optional  

optional The address of the company. Example: 'Suite 101'

city   string  optional  

optional The company city name. Example: Queen Creek

country_state_uuid   string  optional  

optional The company state uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

country_uuid   string  optional  

optional The company country uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

postal_code   string  optional  

optional The postal code of the company. Example: 85410

latitude   string  optional  

optional The latitude of the company. Example: 23.0396

longitude   string  optional  

optional The longitude of the company. Example: 72.566

primary_color   string  optional  

optional The primary color. Example: #009CFF

secondary_color   string  optional  

optional The secondary color. Example: #FFFFFF

custom_settings   object  optional  
settings   object  optional  
available_integration_uuids   object  optional  
website_url   string  optional  

Must be a valid URL. Example: http://adams.biz/tempore-nostrum-qui-ullam-rerum.html

google_my_business_listing   string  optional  

Must be a valid URL. Example: http://www.rosenbaum.net/quasi-adipisci-non-qui-soluta-nobis

image_url   string  optional  

Example: http://www.mosciski.com/et-corporis-doloribus-pariatur-fugiat-et-et-debitis.html

company_uuid   string  optional  

optional The uuid of the company. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

description   string  optional  

optional The company description. Example: We are helping take your business to the next level. Hop in!

requires authentication

Only self can remove his logo.

Redirect to Stripe Billing Auth

requires authentication

This endpoint lets user to redirect to Stripe Billing Auth.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/billing" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/billing';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/billing"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/billing

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

uuid   string   

The company uuid. Example: ecd24580-2749-11ec-9b86-1102c06e74b4

Get settings JSON file URL

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/settings-json" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"settings_name\": \"pariatur\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/settings-json';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'settings_name' => 'pariatur',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/settings-json"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "settings_name": "pariatur"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/settings-json

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

uuid   string   

The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Body Parameters

settings_name   string   

The setting name Example: pariatur

POST Upload Base64 files to S3

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/upload-base64" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"items\": null,
    \"deleteItems\": null
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/upload-base64';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'items' => null,
            'deleteItems' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/upload-base64"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "items": null,
    "deleteItems": null
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/upload-base64

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

items   string[]   

The array of {base64String, uuid} object.

deleteItems   string[]   

The array of uuid object.

Customer Address

API for customer address

Update

requires authentication

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-addresses" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"addresses[]\": null,
    \"delete_addresses[]\": null
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-addresses';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'addresses[]' => null,
            'delete_addresses[]' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-addresses"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "addresses[]": null,
    "delete_addresses[]": null
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/customers/{customer_uuid}/customer-addresses

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   string  optional  

uuid required The UUID of the customer that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Body Parameters

addresses[]   string[]  optional  

of addresses.

delete_addresses[]   string[]  optional  

of addresses.uuid to be deleted.

Patch

requires authentication

Patch Customer Address

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/customers/1/customer-addresses/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"address1\": \"et\",
    \"address2\": \"quaerat\",
    \"city\": \"laborum\",
    \"country_state_uuid\": \"2343b84b-34b5-3106-805b-f7e021ad69a1\",
    \"country_uuid\": \"ff4f1200-a853-315e-af7c-e537d8e6379e\",
    \"postal_code\": \"sit\",
    \"latitude\": \"dolore\",
    \"longitude\": \"omnis\",
    \"is_primary\": \"occaecati\",
    \"settings\": \"sit\",
    \"county\": \"incidunt\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/1/customer-addresses/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'address1' => 'et',
            'address2' => 'quaerat',
            'city' => 'laborum',
            'country_state_uuid' => '2343b84b-34b5-3106-805b-f7e021ad69a1',
            'country_uuid' => 'ff4f1200-a853-315e-af7c-e537d8e6379e',
            'postal_code' => 'sit',
            'latitude' => 'dolore',
            'longitude' => 'omnis',
            'is_primary' => 'occaecati',
            'settings' => 'sit',
            'county' => 'incidunt',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/1/customer-addresses/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "address1": "et",
    "address2": "quaerat",
    "city": "laborum",
    "country_state_uuid": "2343b84b-34b5-3106-805b-f7e021ad69a1",
    "country_uuid": "ff4f1200-a853-315e-af7c-e537d8e6379e",
    "postal_code": "sit",
    "latitude": "dolore",
    "longitude": "omnis",
    "is_primary": "occaecati",
    "settings": "sit",
    "county": "incidunt"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/customers/{customer_uuid}/customer-addresses/{customerAddress_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   integer   

Example: 1

customerAddress_uuid   integer   

Example: 1

Body Parameters

address1   string  optional  

optional The address 1. Example : Address 1 Example: et

address2   string  optional  

optional The address 2. Example : Address 2 Example: quaerat

city   string  optional  

optional The city. Example : Queen Creek Example: laborum

country_state_uuid   string  optional  

optional The state uuid. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: 2343b84b-34b5-3106-805b-f7e021ad69a1

country_uuid   string  optional  

optional The country uuid. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: ff4f1200-a853-315e-af7c-e537d8e6379e

postal_code   string  optional  

optional The postal code. Example : 12345 Example: sit

latitude   string  optional  

optional The latitude. Example : 33.2486 Example: dolore

longitude   string  optional  

optional The longitude. Example : 111.6377 Example: omnis

is_primary   string  optional  

optional The is_primary. Example : true Example: occaecati

settings   string  optional  

optional The settings. Example : {} Example: sit

county   string  optional  

optional The county. Example : Pinal County Example: incidunt

integration_meta   object  optional  

Integration Data

requires authentication

Get data from a 3rd party API

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-addresses/1/integration-data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"addresses[]\": null,
    \"delete_addresses[]\": null
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-addresses/1/integration-data';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'addresses[]' => null,
            'delete_addresses[]' => null,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f/customer-addresses/1/integration-data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "addresses[]": null,
    "delete_addresses[]": null
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/customers/{customer_uuid}/customer-addresses/{customerAddress_uuid}/integration-data

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   string  optional  

uuid required The UUID of the customer that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

customerAddress_uuid   integer   

Example: 1

Body Parameters

addresses[]   string[]  optional  

of addresses.

delete_addresses[]   string[]  optional  

of addresses.uuid to be deleted.

Service Plan Pricing Group

API for Service Plan Pricing Group

List

requires authentication

Shows the list of Service Plan Pricing Group with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/service-plans/{servicePlan_uuid}/pricing-groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

page   integer  optional  

The page number. Example : 1 Example: 12

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 10

sort_by   string  optional  

The column name. Example : name Example: nemo

sort_order   string  optional  

The order in which you want your records. Example : asc Example: quia

search   string  optional  

The general search, it will find matching string. Example : home Example: aut

Create

requires authentication

Store a newly created Service Plan Pricing Group.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pricing_group\": [],
    \"name\": \"Premium Service Plan Pricing Group\",
    \"frequency\": \"MONTHLY\",
    \"pricing_type\": \"DYNAMIC_RANGE_PRICE\",
    \"apply_taxes\": true,
    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipisicing elit...\",
    \"pricing_data\": {
        \"type\": \"The Price\",
        \"default\": \"The Pricing\",
        \"max\": \"1000.00\"
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pricing_group' => [],
            'name' => 'Premium Service Plan Pricing Group',
            'frequency' => 'MONTHLY',
            'pricing_type' => 'DYNAMIC_RANGE_PRICE',
            'apply_taxes' => true,
            'description' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit...',
            'pricing_data' => [
                'type' => 'The Price',
                'default' => 'The Pricing',
                'max' => '1000.00',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pricing_group": [],
    "name": "Premium Service Plan Pricing Group",
    "frequency": "MONTHLY",
    "pricing_type": "DYNAMIC_RANGE_PRICE",
    "apply_taxes": true,
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
    "pricing_data": {
        "type": "The Price",
        "default": "The Pricing",
        "max": "1000.00"
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/service-plans/{servicePlan_uuid}/pricing-groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Body Parameters

pricing_group   object   
name   string   

The name of Service Plan Pricing Group. Example: Premium Service Plan Pricing Group

frequency   string   

The frequency of Service Plan Pricing Group. Example: MONTHLY

pricing_type   string  optional  

The pricing type of Service Plan Pricing Group. Example: DYNAMIC_RANGE_PRICE

apply_taxes   boolean  optional  

The support request details. Example: true

description   string  optional  

The support request details. Example: Lorem ipsum dolor sit amet, consectetur adipisicing elit...

pricing_data   object  optional  

The support request details.

Update (Single/Multiple)

requires authentication

Modify the specified Service Plan Pricing Group. For Single update, body parameter are all required. For Multiple update, @bodyparameter will be an array of the Single @bodyParameter (if uuid is included then perform update; else, create new).

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pricing_group\": [],
    \"save_service_plan_as\": \"SERVICE_PLAN_DRAFT\",
    \"name\": \"Premium Service Plan Pricing Group\",
    \"frequency\": \"MONTHLY\",
    \"pricing_type\": \"DYNAMIC_RANGE_PRICE\",
    \"apply_taxes\": true,
    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipisicing elit...\",
    \"pricing_data\": {
        \"type\": \"The Price\",
        \"default\": \"The Pricing\",
        \"max\": \"1000.00\"
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pricing_group' => [],
            'save_service_plan_as' => 'SERVICE_PLAN_DRAFT',
            'name' => 'Premium Service Plan Pricing Group',
            'frequency' => 'MONTHLY',
            'pricing_type' => 'DYNAMIC_RANGE_PRICE',
            'apply_taxes' => true,
            'description' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit...',
            'pricing_data' => [
                'type' => 'The Price',
                'default' => 'The Pricing',
                'max' => '1000.00',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pricing_group": [],
    "save_service_plan_as": "SERVICE_PLAN_DRAFT",
    "name": "Premium Service Plan Pricing Group",
    "frequency": "MONTHLY",
    "pricing_type": "DYNAMIC_RANGE_PRICE",
    "apply_taxes": true,
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
    "pricing_data": {
        "type": "The Price",
        "default": "The Pricing",
        "max": "1000.00"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/service-plans/{servicePlan_uuid}/pricing-groups

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

Body Parameters

pricing_group   object   
pricing_group_rules   object  optional  
save_service_plan_as   string  optional  

Example: SERVICE_PLAN_DRAFT

Must be one of:
  • SERVICE_PLAN_DRAFT
  • SERVICE_PLAN_ACTIVE
  • SERVICE_PLAN_ARCHIVED
name   string   

The name of Service Plan Pricing Group. Example: Premium Service Plan Pricing Group

frequency   string   

The frequency of Service Plan Pricing Group. Example: MONTHLY

pricing_type   string   

The pricing type of Service Plan Pricing Group. Example: DYNAMIC_RANGE_PRICE

apply_taxes   boolean   

The support request details. Example: true

description   string   

The support request details. Example: Lorem ipsum dolor sit amet, consectetur adipisicing elit...

pricing_data   object   

The support request details.

Get

requires authentication

Display the specified Service Plan Pricing Group.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/501ec580-1106-30bb-a95a-d8a84bc747b1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/501ec580-1106-30bb-a95a-d8a84bc747b1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/501ec580-1106-30bb-a95a-d8a84bc747b1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/service-plans/{servicePlan_uuid}/pricing-groups/{servicePlanPricingGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanPricingGroup_uuid   string   

Example: 501ec580-1106-30bb-a95a-d8a84bc747b1

Update (Single/Multiple)

requires authentication

Modify the specified Service Plan Pricing Group. For Single update, body parameter are all required. For Multiple update, @bodyparameter will be an array of the Single @bodyParameter (if uuid is included then perform update; else, create new).

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/246cdaa2-a35f-3d3d-913f-76855add5493" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pricing_group\": [],
    \"save_service_plan_as\": \"SERVICE_PLAN_ACTIVE\",
    \"name\": \"Premium Service Plan Pricing Group\",
    \"frequency\": \"MONTHLY\",
    \"pricing_type\": \"DYNAMIC_RANGE_PRICE\",
    \"apply_taxes\": true,
    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipisicing elit...\",
    \"pricing_data\": {
        \"type\": \"The Price\",
        \"default\": \"The Pricing\",
        \"max\": \"1000.00\"
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/246cdaa2-a35f-3d3d-913f-76855add5493';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'pricing_group' => [],
            'save_service_plan_as' => 'SERVICE_PLAN_ACTIVE',
            'name' => 'Premium Service Plan Pricing Group',
            'frequency' => 'MONTHLY',
            'pricing_type' => 'DYNAMIC_RANGE_PRICE',
            'apply_taxes' => true,
            'description' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit...',
            'pricing_data' => [
                'type' => 'The Price',
                'default' => 'The Pricing',
                'max' => '1000.00',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/246cdaa2-a35f-3d3d-913f-76855add5493"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "pricing_group": [],
    "save_service_plan_as": "SERVICE_PLAN_ACTIVE",
    "name": "Premium Service Plan Pricing Group",
    "frequency": "MONTHLY",
    "pricing_type": "DYNAMIC_RANGE_PRICE",
    "apply_taxes": true,
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
    "pricing_data": {
        "type": "The Price",
        "default": "The Pricing",
        "max": "1000.00"
    }
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/service-plans/{servicePlan_uuid}/pricing-groups/{servicePlanPricingGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanPricingGroup_uuid   string   

Example: 246cdaa2-a35f-3d3d-913f-76855add5493

Body Parameters

pricing_group   object   
pricing_group_rules   object  optional  
save_service_plan_as   string  optional  

Example: SERVICE_PLAN_ACTIVE

Must be one of:
  • SERVICE_PLAN_DRAFT
  • SERVICE_PLAN_ACTIVE
  • SERVICE_PLAN_ARCHIVED
name   string   

The name of Service Plan Pricing Group. Example: Premium Service Plan Pricing Group

frequency   string   

The frequency of Service Plan Pricing Group. Example: MONTHLY

pricing_type   string   

The pricing type of Service Plan Pricing Group. Example: DYNAMIC_RANGE_PRICE

apply_taxes   boolean   

The support request details. Example: true

description   string   

The support request details. Example: Lorem ipsum dolor sit amet, consectetur adipisicing elit...

pricing_data   object   

The support request details.

Patch

requires authentication

Perform patches for the specified Service Plan Pricing Group.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/6276e369-489b-3eb5-ae88-04406e5ab86a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Premium Service Plan Pricing Group\",
    \"frequency\": \"MONTHLY\",
    \"pricing_type\": \"DYNAMIC_RANGE_PRICE\",
    \"apply_taxes\": true,
    \"description\": \"Lorem ipsum dolor sit amet, consectetur adipisicing elit...\",
    \"pricing_data\": {
        \"type\": \"The Price\",
        \"default\": \"The Pricing\",
        \"max\": \"1000.00\"
    }
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/6276e369-489b-3eb5-ae88-04406e5ab86a';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Premium Service Plan Pricing Group',
            'frequency' => 'MONTHLY',
            'pricing_type' => 'DYNAMIC_RANGE_PRICE',
            'apply_taxes' => true,
            'description' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit...',
            'pricing_data' => [
                'type' => 'The Price',
                'default' => 'The Pricing',
                'max' => '1000.00',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/6276e369-489b-3eb5-ae88-04406e5ab86a"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Premium Service Plan Pricing Group",
    "frequency": "MONTHLY",
    "pricing_type": "DYNAMIC_RANGE_PRICE",
    "apply_taxes": true,
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit...",
    "pricing_data": {
        "type": "The Price",
        "default": "The Pricing",
        "max": "1000.00"
    }
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/service-plans/{servicePlan_uuid}/pricing-groups/{servicePlanPricingGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanPricingGroup_uuid   string   

Example: 6276e369-489b-3eb5-ae88-04406e5ab86a

Body Parameters

name   string  optional  

The name of Service Plan Pricing Group. Example: Premium Service Plan Pricing Group

frequency   string  optional  

The frequency of Service Plan Pricing Group. Example: MONTHLY

pricing_type   string  optional  

The pricing type of Service Plan Pricing Group. Example: DYNAMIC_RANGE_PRICE

apply_taxes   boolean  optional  

The support request details. Example: true

description   string  optional  

The support request details. Example: Lorem ipsum dolor sit amet, consectetur adipisicing elit...

pricing_data   object  optional  

The support request details.

Delete

requires authentication

Remove the specified Service Plan Pricing Group.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/40eb93c2-bfe5-39ad-a67a-50cf43282309" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/40eb93c2-bfe5-39ad-a67a-50cf43282309';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/service-plans/2/pricing-groups/40eb93c2-bfe5-39ad-a67a-50cf43282309"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/service-plans/{servicePlan_uuid}/pricing-groups/{servicePlanPricingGroup_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

servicePlan_uuid   integer   

Example: 2

servicePlanPricingGroup_uuid   string   

Example: 40eb93c2-bfe5-39ad-a67a-50cf43282309

Report

API for report related data

GET api/v1/reports/types

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports/types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports/types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

List

requires authentication

Returns the list of available reports

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 7

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 5

sort_by   string  optional  

The column name. Example : title Example: eaque

sort_order   string  optional  

The order in which you want your records. Example : asc Example: minima

search   string  optional  

The general search, it will find matching string. Example : home Example: ipsam

filter_by_uuids   string  optional  

string[] To filter by selected uuids. Example : [uuid, uuid-2] Example: deleniti

groups   string  optional  

string[] To filter by selected groups. Example : [dashboard, sales] Example: incidunt

report_type   string  optional  

To filter by selected report type. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: et

template   string  optional  

To filter by selected template. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: vel

uuid   string  optional  

optional The company uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Store

requires authentication

Store a newly created report.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/reports" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/reports

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Duplicate

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/reports/1/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/1/duplicate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/1/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/reports/{report_uuid}/duplicate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report_uuid   integer   

Example: 1

Show

requires authentication

Show admin overview report.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports/admin-overview" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/admin-overview';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/admin-overview"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports/admin-overview

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Show

requires authentication

Show a single report.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports/{report_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report_uuid   integer   

Example: 1

user_uuid   string  optional  

optional string The user uuid. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 1bf0da15-12dc-327c-8811-01d6a46bc2cb

period   string  optional  

optional array The period type. Example : [['period_type' => 'days', 'period_detail' => [1, 7, 30, 365]], ['period_type' => 'months', 'period_detail' => ['2023-01-01', '2023-02-02']]] Example: ea

company_location_uuid   string  optional  

optional string The company location uuid. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 5e371c86-9bbe-368c-bcf3-5031c6810561

Export

requires authentication

Export summary reports

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports/1/export" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/1/export';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/1/export"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports/{report_uuid}/export

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report_uuid   integer   

Example: 1

Filters

requires authentication

Retrieve filters to be used in frontend processes

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/reports/1/filters" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/1/filters';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/1/filters"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/reports/{report_uuid}/filters

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report_uuid   integer   

Example: 1

Delete

requires authentication

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/reports/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/reports/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/reports/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/reports/{report_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

report_uuid   integer   

Example: 1

ImportSet

API for ImportSet

Apply Import Set to Company

requires authentication

Store a newly created import set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tags\": [
        \"illum\"
    ],
    \"import_files\": \"unde\",
    \"override\": false,
    \"admin_only\": false
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/import-defaults';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'tags' => [
                'illum',
            ],
            'import_files' => 'unde',
            'override' => false,
            'admin_only' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "tags": [
        "illum"
    ],
    "import_files": "unde",
    "override": false,
    "admin_only": false
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/import-defaults

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: unde

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: false

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: false

Apply Import Set to Company

requires authentication

Store a newly created import set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults/upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tags\": [
        \"qui\"
    ],
    \"import_files\": \"quia\",
    \"override\": false,
    \"admin_only\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/import-defaults/upload';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'tags' => [
                'qui',
            ],
            'import_files' => 'quia',
            'override' => false,
            'admin_only' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults/upload"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "tags": [
        "qui"
    ],
    "import_files": "quia",
    "override": false,
    "admin_only": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/import-defaults/upload

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: quia

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: false

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: true

List

requires authentication

Shows the list of import set with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/import-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/import-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 6

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 7

sort_by   string  optional  

The column name. Example : name Example: sit

sort_order   string  optional  

The order in which you want your records. Example : asc Example: molestias

search   string  optional  

The general search, it will find matching string. Example : "Quality Assurance" Example: vel

type_name   string  optional  

Filter by import type name : "Categories" Example: accusantium

type_code   string  optional  

Filter by import type name : "categories" Example: ea

Body Parameters

type_name   string  optional  
type_code   string  optional  

Show

requires authentication

Show a single import set.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/import-sets/23" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets/23';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets/23"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/import-sets/{importSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

importSet_uuid   integer   

Example: 23

Download

requires authentication

Download a single import set.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/import-sets/23/download" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets/23/download';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets/23/download"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/import-sets/{importSet_uuid}/download

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

importSet_uuid   integer   

Example: 23

Store

requires authentication

Store a newly created import set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/import-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tags\": [
        \"nihil\"
    ],
    \"import_files\": \"et\",
    \"override\": true,
    \"admin_only\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'tags' => [
                'nihil',
            ],
            'import_files' => 'et',
            'override' => true,
            'admin_only' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "tags": [
        "nihil"
    ],
    "import_files": "et",
    "override": true,
    "admin_only": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/import-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: et

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: true

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: true

Update

requires authentication

Update a import set.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/import-sets/23" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"import_files\": \"quia\",
    \"admin_only\": false,
    \"is_selected\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets/23';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'import_files' => 'quia',
            'admin_only' => false,
            'is_selected' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets/23"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "import_files": "quia",
    "admin_only": false,
    "is_selected": true
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/import-sets/{importSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

importSet_uuid   integer   

Example: 23

Body Parameters

import_files   files   

The set of json files containing import settings data. Example: quia

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: false

is_selected   boolean   

Determine if the import set will be automatically selected when popping the dialog. Example : true Example: true

Update the specified resource in storage.

requires authentication

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/import-sets/23" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"admin_only\": false,
    \"is_selected\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets/23';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'admin_only' => false,
            'is_selected' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets/23"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "admin_only": false,
    "is_selected": true
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/import-sets/{importSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

importSet_uuid   integer   

Example: 23

Body Parameters

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: false

is_selected   boolean   

Determine if the import set will be automatically selected when popping the dialog. Example : true Example: true

Delete

requires authentication

Delete a import set.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/import-sets/23" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets/23';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/import-sets/23"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/import-sets/{importSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

importSet_uuid   integer   

Example: 23

List Forms

requires authentication

Shows the list of import set with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/form-import-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/form-import-sets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/form-import-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/form-import-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 18

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 13

sort_by   string  optional  

The column name. Example : name Example: totam

sort_order   string  optional  

The order in which you want your records. Example : asc Example: iusto

search   string  optional  

The general search, it will find matching string. Example : "Quality Assurance" Example: quia

Apply Import Set to Company

requires authentication

Store a newly created import set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/form-import-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tags\": [
        \"qui\"
    ],
    \"import_files\": \"pariatur\",
    \"override\": false,
    \"admin_only\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/form-import-sets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'tags' => [
                'qui',
            ],
            'import_files' => 'pariatur',
            'override' => false,
            'admin_only' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/form-import-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "tags": [
        "qui"
    ],
    "import_files": "pariatur",
    "override": false,
    "admin_only": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/form-import-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: pariatur

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: false

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: true

Form

API for Form

List

requires authentication

Shows the list of form with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/forms

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 1

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 16

sort_by   string  optional  

The column name. Example : name Example: ullam

sort_order   string  optional  

The order in which you want your records. Example : asc Example: nihil

search   string  optional  

The general search, it will find matching string. Example : "Quality Assurance" Example: vel

Get form types

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/form-types" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/form-types';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/form-types"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/form-types

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Show

requires authentication

Show a single form.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/forms/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/forms/{form_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Store

requires authentication

Store a newly created form.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"qui\",
    \"assignment\": \"eum\",
    \"form_fields\": [
        \"impedit\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'qui',
            'assignment' => 'eum',
            'form_fields' => [
                'impedit',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "qui",
    "assignment": "eum",
    "form_fields": [
        "impedit"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/forms

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the form. Example : "My form" Example: qui

assignment   string   

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: eum

form_fields   string[]  optional  

The list of form field data.
*   object  optional  
label   string  optional  

The label of a form field. Example : "Form Field 1" Example: deleniti

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: in

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: possimus

is_required   boolean  optional  

The indicator if form field is required. Example : true Example: false

is_conditional   boolean  optional  

The indicator if form field is conditional. Example : true Example: true

has_help_guide   boolean  optional  

The indicator if form field has a help guide. Example : true Example: true

conditional_value   object  optional  

A json of conditional_value of the form fiel. Example : {"conditional_value":{"form_field_id":123,"operator":"HAS_NO_VALUE"}}

help_guide   string  optional  

The help guide of the form fiel. Example : "This field is to select Yes or No" Example: doloribus

position   integer  optional  

A position of the form fiel. Example : 1 Example: 17

Duplicate

requires authentication

Duplicate form

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/duplicate" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/duplicate';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/duplicate"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/forms/{form_uuid}/duplicate

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Update

requires authentication

Update a form.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"fugit\",
    \"assignment\": \"quisquam\",
    \"form_fields\": [
        \"quasi\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'fugit',
            'assignment' => 'quisquam',
            'form_fields' => [
                'quasi',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "fugit",
    "assignment": "quisquam",
    "form_fields": [
        "quasi"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/forms/{form_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Body Parameters

name   string   

The name of the form. Example : "My Edited Form" Example: fugit

assignment   string   

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: quisquam

form_fields   string[]  optional  

The list of form field data.
*   object  optional  
label   string  optional  

The label of a form field. Example : "Form Field 1" Example: alias

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: a

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: odit

is_required   boolean  optional  

The indicator if form field is required. Example : true Example: false

is_conditional   boolean  optional  

The indicator if form field is conditional. Example : true Example: false

has_help_guide   boolean  optional  

The indicator if form field has a help guide. Example : true Example: false

conditional_value   object  optional  

A json of conditional_value of the form fiel. Example : {"conditional_value":{"form_field_id":123,"operator":"HAS_NO_VALUE"}}

help_guide   string  optional  

The helkp guide of the form fiel. Example : "This field is to select Yes or No" Example: ratione

position   integer  optional  

A position of the form fiel. Example : 1 Example: 8

Update

requires authentication

Update a form.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sit\",
    \"assignment\": \"id\",
    \"form_fields\": [
        \"sit\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'sit',
            'assignment' => 'id',
            'form_fields' => [
                'sit',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sit",
    "assignment": "id",
    "form_fields": [
        "sit"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/forms/{form_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Body Parameters

name   string   

The name of the form. Example : "My Edited Form" Example: sit

assignment   string   

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: id

form_fields   string[]  optional  

The list of form field data.
*   object  optional  
label   string  optional  

The label of a form field. Example : "Form Field 1" Example: placeat

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: ipsum

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: laboriosam

is_required   boolean  optional  

The indicator if form field is required. Example : true Example: false

is_conditional   boolean  optional  

The indicator if form field is conditional. Example : true Example: true

has_help_guide   boolean  optional  

The indicator if form field has a help guide. Example : true Example: false

conditional_value   object  optional  

A json of conditional_value of the form fiel. Example : {"conditional_value":{"form_field_id":123,"operator":"HAS_NO_VALUE"}}

help_guide   string  optional  

The helkp guide of the form fiel. Example : "This field is to select Yes or No" Example: consequatur

position   integer  optional  

A position of the form fiel. Example : 1 Example: 10

Patch

requires authentication

Patch a company form.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptate\",
    \"assignment\": \"quod\",
    \"form_fields\": [
        \"incidunt\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptate',
            'assignment' => 'quod',
            'form_fields' => [
                'incidunt',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptate",
    "assignment": "quod",
    "form_fields": [
        "incidunt"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/forms/{form_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Body Parameters

name   string  optional  

The name of the form. Example : "My Patched Form" Example: voluptate

assignment   string  optional  

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: quod

form_fields   string[]  optional  

The list of form field data.
*   object  optional  
label   string  optional  

The label of a form field. Example : "Form Field 1" Example: maiores

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: eaque

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: esse

is_required   boolean  optional  

The indicator if form field is required. Example : true Example: true

is_conditional   boolean  optional  

The indicator if form field is conditional. Example : true Example: true

has_help_guide   boolean  optional  

The indicator if form field has a help guide. Example : true Example: false

conditional_value   object  optional  

A json of conditional_value of the form fiel. Example : {"conditional_value":{"form_field_id":123,"operator":"HAS_NO_VALUE"}}

help_guide   string  optional  

The helkp guide of the form fiel. Example : "This field is to select Yes or No" Example: facilis

position   integer  optional  

A position of the form fiel. Example : 1 Example: 13

Delete

requires authentication

Delete a form.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/forms/{form_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

form_uuid   integer   

Example: 2

Description Set

API for Description Set

List

requires authentication

Shows the list of description set with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/description-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/description-sets';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/description-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 6

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 8

sort_by   string  optional  

The column name. Example : name Example: voluptas

sort_order   string  optional  

The order in which you want your records. Example : asc Example: quidem

search   string  optional  

The general search, it will find matching string. Example : home Example: repellat

exclude   string  optional  

array An array of UUID to exclude from the results. Example : ['3245d630-24fd-11ec-accd-e397aec85c7f'] Example: non

Show

requires authentication

Show a single description set.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/description-sets/{descriptionSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

descriptionSet_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created description set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"options\": [
        \"est\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/description-sets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'et',
            'options' => [
                'est',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "et",
    "options": [
        "est"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/description-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the description set. Example : "Termite" Example: et

options   string[]   

The options of the description set. Example : [{"title":"Termite","description":["description 1","description 2"]}]

Update

requires authentication

Update a description set.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"omnis\",
    \"options\": [
        \"sequi\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'omnis',
            'options' => [
                'sequi',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "omnis",
    "options": [
        "sequi"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/description-sets/{descriptionSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

descriptionSet_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the description set. Example : "Termite" Example: omnis

options   string[]   

The options of the description set. Example : [{"title":"Termite","description":["description 1","description 2"]}]

Patch

requires authentication

Patch a company description set.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"molestiae\",
    \"options\": [
        \"odit\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'molestiae',
            'options' => [
                'odit',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "molestiae",
    "options": [
        "odit"
    ]
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/description-sets/{descriptionSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

descriptionSet_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the description set. Example : "Termite" Example: molestiae

options   string[]  optional  

The options of the description set. Example : [{"title":"Termite","description":["description 1","description 2"]}]

Delete

requires authentication

Delete a description set.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/description-sets/{descriptionSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

descriptionSet_uuid   integer   

Example: 1

Home

Index

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Referral Source

API for Referral Source

List

requires authentication

Shows the list of referral sources.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/referral-sources';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/referral-sources

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 19

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 5

sort_by   string  optional  

The column name. Example : name Example: sit

sort_order   string  optional  

The order in which you want your records. Example : asc Example: facilis

search   string  optional  

The general search, it will find matching string. Example : home Example: sunt

Show

requires authentication

Show a single referral source.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/referral-sources/{referralSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

referralSource_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created referral source.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"sunt\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"integration_source_id\": \"1234263\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/referral-sources';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'sunt',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'integration_source_id' => '1234263',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "sunt",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "integration_source_id": "1234263"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/referral-sources

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the referral source. Example : Referral Source 1 Example: sunt

description   string   

The attributes of the referral source. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

integration_source_id   string  optional  

optional The image source id of the referral source. Example: 1234263

Update

requires authentication

Update a referral source.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"neque\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"integration_source_id\": \"1234263\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'neque',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'integration_source_id' => '1234263',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "neque",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "integration_source_id": "1234263"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/referral-sources/{referralSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

referralSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the referral source. Example : Referral Source 1 Example: neque

description   string   

The attributes of the referral source. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

integration_source_id   string  optional  

optional The image source id of the referral source. Example: 1234263

Patch

requires authentication

Patch a company referral source.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pariatur\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"integration_source_id\": \"1234263\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'pariatur',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'integration_source_id' => '1234263',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "pariatur",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "integration_source_id": "1234263"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/referral-sources/{referralSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

referralSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the referral source. Example : Referral Source 1 Example: pariatur

description   string   

The attributes of the referral source. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

integration_source_id   string  optional  

optional The image source id of the referral source. Example: 1234263

Delete

requires authentication

Delete a referral source.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/referral-sources/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/referral-sources/{referralSource_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

referralSource_uuid   integer   

Example: 1

Solution

API for Solution

List

requires authentication

Shows the list of solutions.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solutions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/solutions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 16

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 10

sort_by   string  optional  

The column name. Example : name Example: libero

sort_order   string  optional  

The order in which you want your records. Example : asc Example: ullam

search   string  optional  

The general search, it will find matching string. Example : home Example: sed

filter_by_solution_category_uuids   string  optional  

array To filter the list of solutions by solution category. Example : ["3c787d66-2a4f-3f1d-9591-c330be0abe82"] Example: rerum

filter_by_status_uuid   string  optional  

To filter the list the status. Example : "3c787d66-2a4f-3f1d-9591-c330be0abe82" Example: c730b9fc-235f-3446-b31f-68b633a5dc69

Show

requires authentication

Show a single solution.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solutions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/solutions/{solution_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Store

requires authentication

Store a new solution.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/solutions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"solution_category_uuid\": \"080362c8-baf6-3f9e-a451-9bf4e1eca002\",
    \"name\": \"nemo\",
    \"slug\": \"solution-1\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"video_url\": \"\\\"https::somevideo.com\\/thevideoforpestroutes\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'solution_category_uuid' => '080362c8-baf6-3f9e-a451-9bf4e1eca002',
            'name' => 'nemo',
            'slug' => 'solution-1',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'video_url' => '"https::somevideo.com/thevideoforpestroutes"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "solution_category_uuid": "080362c8-baf6-3f9e-a451-9bf4e1eca002",
    "name": "nemo",
    "slug": "solution-1",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "video_url": "\"https::somevideo.com\/thevideoforpestroutes\""
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/solutions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

solution_category_uuid   uuid   

The solution category of the solution. Example : "3c787d66-2a4f-3f1d-9591-c330be0abe82" Example: 080362c8-baf6-3f9e-a451-9bf4e1eca002

name   string   

The name of the solution. Example : Solution 1 Example: nemo

slug   string  optional  

The slug of the solution category. Example: solution-1

description   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

video_url   string  optional  

The video url of the solution. Example: "https::somevideo.com/thevideoforpestroutes"

Store Image

requires authentication

Upload an image to solution

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/solutions/upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "fileUpload=@/tmp/phpDWbfe2" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/upload';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phpDWbfe2', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/upload"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "multipart/form-data",
    "Accept": "application/json",
};

const body = new FormData();
body.append('fileUpload', document.querySelector('input[name="fileUpload"]').files[0]);

fetch(url, {
    method: "POST",
    headers,
    body,
}).then(response => response.json());

Request      

POST api/v1/solutions/upload

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: multipart/form-data

Accept      

Example: application/json

Body Parameters

fileUpload   file   

The file to be uploaded. Example: /tmp/phpDWbfe2

Update

requires authentication

Update a solution.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solutions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"solution_category_uuid\": \"3a788730-1330-3f5c-a33f-7003e65b48d5\",
    \"name\": \"adipisci\",
    \"slug\": \"solution-1\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"video_url\": \"\\\"https::somevideo.com\\/thevideoforpestroutes\\\"\",
    \"status_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'solution_category_uuid' => '3a788730-1330-3f5c-a33f-7003e65b48d5',
            'name' => 'adipisci',
            'slug' => 'solution-1',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'video_url' => '"https::somevideo.com/thevideoforpestroutes"',
            'status_uuid' => '"3c787d66-2a4f-3f1d-9591-c330be0abe82"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "solution_category_uuid": "3a788730-1330-3f5c-a33f-7003e65b48d5",
    "name": "adipisci",
    "slug": "solution-1",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "video_url": "\"https::somevideo.com\/thevideoforpestroutes\"",
    "status_uuid": "\"3c787d66-2a4f-3f1d-9591-c330be0abe82\""
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/solutions/{solution_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Body Parameters

solution_category_uuid   uuid   

The solution category of the solution. Example : "3c787d66-2a4f-3f1d-9591-c330be0abe82" Example: 3a788730-1330-3f5c-a33f-7003e65b48d5

name   string   

The name of the solution. Example : Solution 1 Example: adipisci

slug   string  optional  

The slug of the solution category. Example: solution-1

description   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

video_url   string  optional  

The video url of the solution. Example: "https::somevideo.com/thevideoforpestroutes"

status_uuid   string  optional  

The video url of the solution. Example: "3c787d66-2a4f-3f1d-9591-c330be0abe82"

Reset

requires authentication

Reset a solution's user progress.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solutions/1/reset" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/reset';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/reset"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers,
}).then(response => response.json());

Request      

PUT api/v1/solutions/{solution_uuid}/reset

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Update user progress

requires authentication

Update user progress.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/solutions/1/user-progress" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_completed\": true,
    \"step\": []
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/user-progress';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'is_completed' => true,
            'step' => [],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/user-progress"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "is_completed": true,
    "step": []
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/solutions/{solution_uuid}/user-progress

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Body Parameters

is_completed   boolean  optional  

The solution category of the solution. Example : false Example: true

step   object  optional  

The current step the use is on. Example : 2

Patch Index

requires authentication

Performs specific updates for solutions

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/solutions/1/sort" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/sort';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/sort"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/solutions/{solutionCategory_uuid}/sort

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

solutions_ranking_list   string  optional  

string[] A dictionary of uuids with uuid as key and rank as the value. Example : {"69e56cdf-cea8-4356-b35d-58d610aba886" : 1, "9c578b77-916a-4620-a246-fa951f422912" : 2} Example: ipsa

Patch

requires authentication

Patch a solution.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/solutions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"solution_category_uuid\": \"9383d476-7040-3251-b3c3-a33c20a10a54\",
    \"name\": \"itaque\",
    \"slug\": \"solution-1\",
    \"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
    \"video_url\": \"\\\"https::somevideo.com\\/thevideoforpestroutes\\\"\",
    \"status_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'solution_category_uuid' => '9383d476-7040-3251-b3c3-a33c20a10a54',
            'name' => 'itaque',
            'slug' => 'solution-1',
            'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
            'video_url' => '"https::somevideo.com/thevideoforpestroutes"',
            'status_uuid' => '"3c787d66-2a4f-3f1d-9591-c330be0abe82"',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "solution_category_uuid": "9383d476-7040-3251-b3c3-a33c20a10a54",
    "name": "itaque",
    "slug": "solution-1",
    "description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
    "video_url": "\"https::somevideo.com\/thevideoforpestroutes\"",
    "status_uuid": "\"3c787d66-2a4f-3f1d-9591-c330be0abe82\""
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/solutions/{solution_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Body Parameters

solution_category_uuid   uuid  optional  

The solution category of the solution. Example : "3c787d66-2a4f-3f1d-9591-c330be0abe82" Example: 9383d476-7040-3251-b3c3-a33c20a10a54

name   string  optional  

The name of the solution. Example : Solution 1 Example: itaque

slug   string  optional  

The slug of the solution category. Example: solution-1

description   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

video_url   string  optional  

The video url of the solution. Example: "https::somevideo.com/thevideoforpestroutes"

status_uuid   string  optional  

The video url of the solution. Example: "3c787d66-2a4f-3f1d-9591-c330be0abe82"

Delete

requires authentication

Delete a solution.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/solutions/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/solutions/{solution_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

Customer

API for customers

List

requires authentication

Shows the list of company customers that the user has access to view.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/customers?page=1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"page_size\": 15,
    \"sort_by\": \"display_name\",
    \"sort_order\": \"asc\",
    \"search\": \"John\",
    \"filter_by_company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"filter_by_statuses_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"is_with_trashed\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'query' => [
            'page' => '1',
        ],
        'json' => [
            'page_size' => 15,
            'sort_by' => 'display_name',
            'sort_order' => 'asc',
            'search' => 'John',
            'filter_by_company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'filter_by_statuses_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'is_with_trashed' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers"
);

const params = {
    "page": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "page_size": 15,
    "sort_by": "display_name",
    "sort_order": "asc",
    "search": "John",
    "filter_by_company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "filter_by_statuses_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "is_with_trashed": true
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

GET api/v1/customers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Query Parameters

page   integer  optional  

optional The page number. Example: 1

Body Parameters

page_size   integer  optional  

optional The number of records you want per page. Example: 15

sort_by   string  optional  

optional The column name. Example: display_name

sort_order   string  optional  

optional The order in which you want your records. Example: asc

search   string  optional  

optional The general search, it will find matching string. Example: John

filter_by_company_location_uuid   string  optional  

uuid optional Filter results by company location uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

filter_by_statuses_uuid   string  optional  

uuid optional Filter results by company location uuid. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

is_with_trashed   boolean  optional  

Whether or not to include trashed customer, addresses and contacts. Example: true

Show

requires authentication

This endpoint returns detail of a certain customer.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/customers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/customers/{customer_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   integer   

Example: 1

Store

requires authentication

Create a new customer along with their primary contact and address

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/customers" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"account_name\": \"Smarter Launch LLC\",
    \"customer_contact\": [
        \"aut\"
    ],
    \"customer_address\": [
        \"et\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'account_name' => 'Smarter Launch LLC',
            'customer_contact' => [
                'aut',
            ],
            'customer_address' => [
                'et',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "account_name": "Smarter Launch LLC",
    "customer_contact": [
        "aut"
    ],
    "customer_address": [
        "et"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/customers

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

company_location_uuid   uuid   

The company location UUID. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

account_name   string   

The account name. Example: Smarter Launch LLC

customer_contact   string[]   

The customer contacts
*   object  optional  
first_name   string   

The first name of the primary contact for the customer. Example: John

last_name   string   

The last name of the primary contact for the customer. Example: Smith

email   string   

The email address of the primary contact for the customer. Example: john.smith@smarterlaunch.com

phone   string   

The phone number of the primary contact for the customer. Example: 5554448888

customer_address   string[]   

The contact addresses
*   object  optional  
address1   string   

The address of the primary service address of the customer. Example: 123 Smarter Launch Way

address2   string  optional  

The extended address for the primary service address of the customer. Example: Suite 123

city   string   

The city for the primary service address of the customer. Example: Queen Creek

country_state_uuid   uuid   

The state UUID for the primary service address of the customer. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

postal_code   string   

The postal code for the primary service address of the customer. Example: 85140

country_uuid   uuid   

The country UUID for the primary service address of the customer. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update with contact and address

requires authentication

This is to update those partial customer data

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/customers/1/with-contact-address" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
    \"account_name\": \"Smarter Launch LLC\",
    \"customer_contact\": [
        \"tempora\"
    ],
    \"customer_address\": [
        \"numquam\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/1/with-contact-address';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
            'account_name' => 'Smarter Launch LLC',
            'customer_contact' => [
                'tempora',
            ],
            'customer_address' => [
                'numquam',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/1/with-contact-address"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f",
    "account_name": "Smarter Launch LLC",
    "customer_contact": [
        "tempora"
    ],
    "customer_address": [
        "numquam"
    ]
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/customers/{customer_uuid}/with-contact-address

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   integer   

Example: 1

Body Parameters

company_location_uuid   uuid   

The company location UUID. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

account_name   string   

The account name. Example: Smarter Launch LLC

customer_contact   string[]   

The customer contacts
*   object  optional  
first_name   string   

The first name of the primary contact for the customer. Example: John

last_name   string   

The last name of the primary contact for the customer. Example: Smith

email   string   

The email address of the primary contact for the customer. Example: john.smith@smarterlaunch.com

phone   string   

The phone number of the primary contact for the customer. Example: 5554448888

customer_address   string[]   

The contact addresses
*   object  optional  
address1   string   

The address of the primary service address of the customer. Example: 123 Smarter Launch Way

address2   string  optional  

The extended address for the primary service address of the customer. Example: Suite 123

city   string   

The city for the primary service address of the customer. Example: Queen Creek

country_state_uuid   uuid   

The state UUID for the primary service address of the customer. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

postal_code   string   

The postal code for the primary service address of the customer. Example: 85140

country_uuid   uuid   

The country UUID for the primary service address of the customer. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Update

requires authentication

Update individual customer account name and the location they are associated with.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"3245d634-24fd-11ec-accd-e397aec85c7f\",
    \"account_name\": \"Smarter Launch LLC\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '3245d634-24fd-11ec-accd-e397aec85c7f',
            'account_name' => 'Smarter Launch LLC',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "3245d634-24fd-11ec-accd-e397aec85c7f",
    "account_name": "Smarter Launch LLC"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/customers/{customer_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   string  optional  

uuid required The UUID of the customer that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Body Parameters

company_location_uuid   uuid   

The UUID of the company location to associate the customer with. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

account_name   string   

The account name. Example: Smarter Launch LLC

referral_source_uuid   string  optional  
include_fields   string  optional  

Patch

requires authentication

Patch individual customer account name and the location they are associated with.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"3245d634-24fd-11ec-accd-e397aec85c7f\",
    \"account_name\": \"Smarter Launch LLC\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '3245d634-24fd-11ec-accd-e397aec85c7f',
            'account_name' => 'Smarter Launch LLC',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/3245d634-24fd-11ec-accd-e397aec85c7f"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "company_location_uuid": "3245d634-24fd-11ec-accd-e397aec85c7f",
    "account_name": "Smarter Launch LLC"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/customers/{customer_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   string  optional  

uuid required The UUID of the customer that is to be updated. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

Body Parameters

company_location_uuid   uuid   

The UUID of the company location to associate the customer with. Example: 3245d634-24fd-11ec-accd-e397aec85c7f

account_name   string   

The account name. Example: Smarter Launch LLC

Delete

requires authentication

This end point allows user the delete the customer.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/customers/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};

fetch(url, {
    method: "DELETE",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

DELETE api/v1/customers/{customer_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   integer   

Example: 1

Body Parameters

uuid   string   

The uuid of the customer. Example: 3245d630-24fd-11ec-accd-e397aec85c7f

Sync

requires authentication

This endpoint allows user to perform manual sync to a customer

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/customers/1/sync" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/customers/1/sync';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/customers/1/sync"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PATCH",
    headers,
}).then(response => response.json());

Request      

PATCH api/v1/customers/{customer_uuid}/sync

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

customer_uuid   integer   

Example: 1

Fetch all available industry

requires authentication

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/industries" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/industries';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/industries"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/industries

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Category

API for Category

List

requires authentication

Shows the list of Categories with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/categories';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 20

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 7

sort_by   string  optional  

The column name. Example : name Example: assumenda

sort_order   string  optional  

The order in which you want your records. Example : asc Example: ab

search   string  optional  

The general search, it will find matching string. Example : home Example: laudantium

category_group   string  optional  

The category group to filter by. Example : SERVICE_PLAN Example: sunt

Create

requires authentication

Store a newly created Category.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"category_group\": \"SERVICE_PLAN\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/categories';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Small Pests',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'category_group' => 'SERVICE_PLAN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/categories"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "category_group": "SERVICE_PLAN"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the category. Example: Small Pests

description   string  optional  

The description of the category. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

category_group   string   

The category_group of the category. ['SERVICE_PLAN']. Example: SERVICE_PLAN

Get

requires authentication

Display the specified Category.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/categories/1';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Update

requires authentication

Modify the specified Category.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"category_group\": \"DRAWING_SYMBOL\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/categories/1';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Small Pests',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'category_group' => 'DRAWING_SYMBOL',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "category_group": "DRAWING_SYMBOL"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the category. Example: Small Pests

description   string  optional  

The description of the category. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

category_group   string  optional  

Example: DRAWING_SYMBOL

Must be one of:
  • SERVICE_PLAN
  • DRAWING_SYMBOL

Patch

requires authentication

Perform patches for the specified Category.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"category_group\": \"SERVICE_PLAN\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/categories/1';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'Small Pests',
            'description' => 'Lorem ipsum dolor sit amet consectetur adipisicing elit',
            'category_group' => 'SERVICE_PLAN',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "category_group": "SERVICE_PLAN"
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the category. Example: Small Pests

description   string  optional  

The description of the category. Example: Lorem ipsum dolor sit amet consectetur adipisicing elit

category_group   string  optional  

Example: SERVICE_PLAN

Must be one of:
  • SERVICE_PLAN
  • DRAWING_SYMBOL

Delete

requires authentication

Remove the specified Category.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/categories/1';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/categories/1"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Schedule

API for Schedule

List

requires authentication

Shows the list of schedule with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/schedules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/schedules';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/schedules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 18

page_size   integer  optional  

The number of record you want per page. Example : 5 Example: 4

sort_by   string  optional  

The column name. Example : name Example: possimus

sort_order   string  optional  

The order in which you want your records. Example : asc Example: voluptate

search   string  optional  

The general search, it will find matching string. Example : home Example: esse

type   string  optional  

in:'service','billing' The filter by type. Example : service Example: quis

Show

requires authentication

Show a single schedule.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/schedules/2';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Request      

GET api/v1/companies/{company_uuid}/schedules/{schedule_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

schedule_uuid   integer   

Example: 2

Store

requires authentication

Store a newly created schedule.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"voluptas\",
    \"description\": \"At iste ut tempora quod delectus alias modi.\",
    \"type\": \"magni\",
    \"units\": 6,
    \"term\": \"sapiente\",
    \"enabled_service_months\": [
        \"fugiat\"
    ],
    \"visits\": 2
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/schedules';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'voluptas',
            'description' => 'At iste ut tempora quod delectus alias modi.',
            'type' => 'magni',
            'units' => 6,
            'term' => 'sapiente',
            'enabled_service_months' => [
                'fugiat',
            ],
            'visits' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "voluptas",
    "description": "At iste ut tempora quod delectus alias modi.",
    "type": "magni",
    "units": 6,
    "term": "sapiente",
    "enabled_service_months": [
        "fugiat"
    ],
    "visits": 2
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

POST api/v1/companies/{company_uuid}/schedules

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the schedule. Example : "My Schedule" Example: voluptas

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: At iste ut tempora quod delectus alias modi.

type   string   

The type of the schedule (service, billing). Example : "service" Example: magni

units   integer   

The number of week(s)/month(s)/year(s) of a schedule. Example : 5 Example: 6

term   string   

The terms of the schedule (week/month/year). Example : week Example: sapiente

enabled_service_months   string[]   

The list of integer which represents a month. Example : [1, 2, 12] means ["January", "February", "December"]

visits   integer  optional  

The number of visits of the schedule. Example : 52 Example: 2

Update

requires authentication

Update a schedule.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nihil\",
    \"description\": \"Ut nobis minus magnam veniam deleniti unde soluta.\",
    \"type\": \"sit\",
    \"units\": 12,
    \"term\": \"velit\",
    \"enabled_service_months\": [
        \"incidunt\"
    ],
    \"visits\": 2
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/schedules/2';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'nihil',
            'description' => 'Ut nobis minus magnam veniam deleniti unde soluta.',
            'type' => 'sit',
            'units' => 12,
            'term' => 'velit',
            'enabled_service_months' => [
                'incidunt',
            ],
            'visits' => 2,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "nihil",
    "description": "Ut nobis minus magnam veniam deleniti unde soluta.",
    "type": "sit",
    "units": 12,
    "term": "velit",
    "enabled_service_months": [
        "incidunt"
    ],
    "visits": 2
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PUT api/v1/companies/{company_uuid}/schedules/{schedule_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

schedule_uuid   integer   

Example: 2

Body Parameters

name   string   

The name of the schedule. Example : "My Schedule" Example: nihil

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Ut nobis minus magnam veniam deleniti unde soluta.

type   string   

The type of the schedule (service, billing). Example : "service" Example: sit

units   integer   

The number of week(s)/month(s)/year(s) of a schedule. Example : 5 Example: 12

term   string   

The terms of the schedule (week/month/year). Example : week Example: velit

enabled_service_months   string[]   

The list of integer which represents a month. Example : [1, 2, 12] means ["January", "February", "December"]

visits   integer  optional  

The number of visits of the schedule. Example : 52 Example: 2

Patch

requires authentication

Patch a company schedule.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"description\": \"Ex voluptatem consequatur consequuntur aspernatur omnis corrupti temporibus.\",
    \"type\": \"repellendus\",
    \"units\": 5,
    \"term\": \"tenetur\",
    \"enabled_service_months\": [
        \"explicabo\"
    ],
    \"visits\": 11
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/schedules/2';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'et',
            'description' => 'Ex voluptatem consequatur consequuntur aspernatur omnis corrupti temporibus.',
            'type' => 'repellendus',
            'units' => 5,
            'term' => 'tenetur',
            'enabled_service_months' => [
                'explicabo',
            ],
            'visits' => 11,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "name": "et",
    "description": "Ex voluptatem consequatur consequuntur aspernatur omnis corrupti temporibus.",
    "type": "repellendus",
    "units": 5,
    "term": "tenetur",
    "enabled_service_months": [
        "explicabo"
    ],
    "visits": 11
};

fetch(url, {
    method: "PATCH",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Request      

PATCH api/v1/companies/{company_uuid}/schedules/{schedule_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

schedule_uuid   integer   

Example: 2

Body Parameters

name   string   

The name of the schedule. Example : "My Schedule" Example: et

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Ex voluptatem consequatur consequuntur aspernatur omnis corrupti temporibus.

type   string   

The type of the schedule (service, billing). Example : "service" Example: repellendus

units   integer   

The number of week(s)/month(s)/year(s) of a schedule. Example : 5 Example: 5

term   string   

The terms of the schedule (week/month/year). Example : week Example: tenetur

enabled_service_months   string[]   

The list of integer which represents a month. Example : [1, 2, 12] means ["January", "February", "December"]

visits   integer  optional  

The number of visits of the schedule. Example : 52 Example: 11

Delete

requires authentication

Delete a schedule.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/schedules/2';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/schedules/2"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers,
}).then(response => response.json());

Request      

DELETE api/v1/companies/{company_uuid}/schedules/{schedule_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

schedule_uuid   integer   

Example: 2