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: 9

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: sint

sort_order   string  optional  

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

search   string  optional  

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

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\": \"qui\",
    \"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\": 31099.53245859
}"
$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' => 'qui',
            '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' => 31099.53245859,
        ],
    ]
);
$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": "qui",
    "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": 31099.53245859
};

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: qui

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: 31099.53245859

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\": \"temporibus\",
    \"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\": 2.3765,
    \"save_as\": \"SERVICE_PLAN_ACTIVE\"
}"
$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' => 'temporibus',
            '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' => 2.3765,
            'save_as' => 'SERVICE_PLAN_ACTIVE',
        ],
    ]
);
$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": "temporibus",
    "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": 2.3765,
    "save_as": "SERVICE_PLAN_ACTIVE"
};

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: temporibus

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: 2.3765

save_as   string  optional  

Example: SERVICE_PLAN_ACTIVE

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\": \"tempore\",
    \"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\": 69401.5803,
    \"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' => 'tempore',
            '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' => 69401.5803,
            '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": "tempore",
    "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": 69401.5803,
    "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: tempore

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: 69401.5803

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: 2

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: quidem

sort_order   string  optional  

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

search   string  optional  

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

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\": \"rem\",
    \"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' => 'rem',
            '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": "rem",
    "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: rem

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\": \"praesentium\",
    \"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' => 'praesentium',
            '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": "praesentium",
    "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: praesentium

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\": \"perferendis\",
    \"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' => 'perferendis',
            '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": "perferendis",
    "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: perferendis

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: 14

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: debitis

sort_order   string  optional  

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

search   string  optional  

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

is_enabled   string  optional  

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

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\": [
        \"voluptas\"
    ],
    \"filters\": [
        \"neque\"
    ],
    \"triggers\": [
        \"est\"
    ]
}"
$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' => [
                'voluptas',
            ],
            'filters' => [
                'neque',
            ],
            'triggers' => [
                'est',
            ],
        ],
    ]
);
$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": [
        "voluptas"
    ],
    "filters": [
        "neque"
    ],
    "triggers": [
        "est"
    ]
};

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\": [
        \"sunt\"
    ],
    \"filters\": [
        \"esse\"
    ],
    \"triggers\": [
        \"neque\"
    ]
}"
$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' => [
                'sunt',
            ],
            'filters' => [
                'esse',
            ],
            'triggers' => [
                'neque',
            ],
        ],
    ]
);
$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": [
        "sunt"
    ],
    "filters": [
        "esse"
    ],
    "triggers": [
        "neque"
    ]
};

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\": [
        \"facere\"
    ],
    \"filters\": [
        \"aut\"
    ],
    \"triggers\": [
        \"ratione\"
    ]
}"
$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' => [
                'facere',
            ],
            'filters' => [
                'aut',
            ],
            'triggers' => [
                'ratione',
            ],
        ],
    ]
);
$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": [
        "facere"
    ],
    "filters": [
        "aut"
    ],
    "triggers": [
        "ratione"
    ]
};

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: 6

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: omnis

sort_order   string  optional  

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

search   string  optional  

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

is_all_location   string  optional  

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

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=consequatur"\
    --form "message=aliquam"\
    --form "rate=illo"\
    --form "external_photo_url=http://www.boyer.com/"\
    --form "position=19"\
    --form "company_location_uuid=c86e2138-130b-394a-917e-4e69ce5a6b42"\
    --form "photo=@/tmp/phpzdjPeP" 
$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' => 'consequatur'
            ],
            [
                'name' => 'message',
                'contents' => 'aliquam'
            ],
            [
                'name' => 'rate',
                'contents' => 'illo'
            ],
            [
                'name' => 'external_photo_url',
                'contents' => 'http://www.boyer.com/'
            ],
            [
                'name' => 'position',
                'contents' => '19'
            ],
            [
                'name' => 'company_location_uuid',
                'contents' => 'c86e2138-130b-394a-917e-4e69ce5a6b42'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/phpzdjPeP', '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', 'consequatur');
body.append('message', 'aliquam');
body.append('rate', 'illo');
body.append('external_photo_url', 'http://www.boyer.com/');
body.append('position', '19');
body.append('company_location_uuid', 'c86e2138-130b-394a-917e-4e69ce5a6b42');
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: consequatur

message   string  optional  

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

rate   string   

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

photo   file  optional  

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

external_photo_url   string  optional  

An external url of an image as review/photo. Example: http://www.boyer.com/

position   integer  optional  

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

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: c86e2138-130b-394a-917e-4e69ce5a6b42

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=delectus"\
    --form "message=qui"\
    --form "rate=totam"\
    --form "external_photo_url=http://shields.info/optio-nobis-quo-laborum-corporis-voluptatum"\
    --form "position=8"\
    --form "company_location_uuid=fc647904-769a-395c-b5c5-e0fef9975a8a"\
    --form "photo=@/tmp/phpPrtHrN" 
$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' => 'delectus'
            ],
            [
                'name' => 'message',
                'contents' => 'qui'
            ],
            [
                'name' => 'rate',
                'contents' => 'totam'
            ],
            [
                'name' => 'external_photo_url',
                'contents' => 'http://shields.info/optio-nobis-quo-laborum-corporis-voluptatum'
            ],
            [
                'name' => 'position',
                'contents' => '8'
            ],
            [
                'name' => 'company_location_uuid',
                'contents' => 'fc647904-769a-395c-b5c5-e0fef9975a8a'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/phpPrtHrN', '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', 'delectus');
body.append('message', 'qui');
body.append('rate', 'totam');
body.append('external_photo_url', 'http://shields.info/optio-nobis-quo-laborum-corporis-voluptatum');
body.append('position', '8');
body.append('company_location_uuid', 'fc647904-769a-395c-b5c5-e0fef9975a8a');
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: delectus

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: totam

photo   file  optional  

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

external_photo_url   string  optional  

An external url of an image as review/photo. Example: http://shields.info/optio-nobis-quo-laborum-corporis-voluptatum

position   integer  optional  

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

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: fc647904-769a-395c-b5c5-e0fef9975a8a

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: magnam

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\": \"perferendis\",
    \"message\": \"dignissimos\",
    \"rate\": \"perspiciatis\",
    \"external_photo_url\": \"https:\\/\\/www.skiles.org\\/qui-est-sunt-aspernatur-quo-dolorem\",
    \"position\": 13,
    \"company_location_uuid\": \"a9e4a5f6-74f7-3ad2-8efd-2d3624a71820\"
}"
$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' => 'perferendis',
            'message' => 'dignissimos',
            'rate' => 'perspiciatis',
            'external_photo_url' => 'https://www.skiles.org/qui-est-sunt-aspernatur-quo-dolorem',
            'position' => 13,
            'company_location_uuid' => 'a9e4a5f6-74f7-3ad2-8efd-2d3624a71820',
        ],
    ]
);
$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": "perferendis",
    "message": "dignissimos",
    "rate": "perspiciatis",
    "external_photo_url": "https:\/\/www.skiles.org\/qui-est-sunt-aspernatur-quo-dolorem",
    "position": 13,
    "company_location_uuid": "a9e4a5f6-74f7-3ad2-8efd-2d3624a71820"
};

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: perferendis

message   string  optional  

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

rate   string  optional  

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

external_photo_url   string  optional  

An external url of an image as review/photo. Example: https://www.skiles.org/qui-est-sunt-aspernatur-quo-dolorem

position   integer  optional  

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

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: a9e4a5f6-74f7-3ad2-8efd-2d3624a71820

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: 9

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: veritatis

sort_order   string  optional  

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

search   string  optional  

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

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/ae058320-5b21-367b-b1a0-52d80e09cae5" \
    --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/ae058320-5b21-367b-b1a0-52d80e09cae5';
$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/ae058320-5b21-367b-b1a0-52d80e09cae5"
);

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: ae058320-5b21-367b-b1a0-52d80e09cae5

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\": \"ipsam\",
    \"input_type\": \"eos\",
    \"default_value\": \"qui\",
    \"is_required\": false,
    \"is_conditional\": true,
    \"has_help_guide\": false,
    \"conditional_value\": \"veniam\",
    \"help_guide\": \"debitis\",
    \"position\": 1
}"
$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' => 'ipsam',
            'input_type' => 'eos',
            'default_value' => 'qui',
            'is_required' => false,
            'is_conditional' => true,
            'has_help_guide' => false,
            'conditional_value' => 'veniam',
            'help_guide' => 'debitis',
            'position' => 1,
        ],
    ]
);
$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": "ipsam",
    "input_type": "eos",
    "default_value": "qui",
    "is_required": false,
    "is_conditional": true,
    "has_help_guide": false,
    "conditional_value": "veniam",
    "help_guide": "debitis",
    "position": 1
};

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: ipsam

input_type   string   

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

default_value   string  optional  

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

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: false

conditional_value   text  optional  

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

help_guide   string  optional  

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

position   integer  optional  

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

Update

requires authentication

Update a formfield.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/89bcb7e7-dad4-372f-a377-4dc85c7105d5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"voluptatem\",
    \"input_type\": \"illum\",
    \"default_value\": \"accusantium\",
    \"is_required\": false,
    \"is_conditional\": false,
    \"has_help_guide\": false,
    \"conditional_value\": \"ut\",
    \"help_guide\": \"ut\",
    \"position\": 10
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/89bcb7e7-dad4-372f-a377-4dc85c7105d5';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'voluptatem',
            'input_type' => 'illum',
            'default_value' => 'accusantium',
            'is_required' => false,
            'is_conditional' => false,
            'has_help_guide' => false,
            'conditional_value' => 'ut',
            'help_guide' => 'ut',
            'position' => 10,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/89bcb7e7-dad4-372f-a377-4dc85c7105d5"
);

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

let body = {
    "label": "voluptatem",
    "input_type": "illum",
    "default_value": "accusantium",
    "is_required": false,
    "is_conditional": false,
    "has_help_guide": false,
    "conditional_value": "ut",
    "help_guide": "ut",
    "position": 10
};

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: 89bcb7e7-dad4-372f-a377-4dc85c7105d5

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: illum

default_value   string  optional  

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

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: 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: ut

help_guide   string  optional  

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

position   integer  optional  

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

Update

requires authentication

Update a formfield.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/afd7ea16-e295-37f0-84a8-fe2fdd0232ee" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"ut\",
    \"input_type\": \"sit\",
    \"default_value\": \"rerum\",
    \"is_required\": false,
    \"is_conditional\": true,
    \"has_help_guide\": false,
    \"conditional_value\": \"rerum\",
    \"help_guide\": \"quo\",
    \"position\": 11
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/afd7ea16-e295-37f0-84a8-fe2fdd0232ee';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'ut',
            'input_type' => 'sit',
            'default_value' => 'rerum',
            'is_required' => false,
            'is_conditional' => true,
            'has_help_guide' => false,
            'conditional_value' => 'rerum',
            'help_guide' => 'quo',
            '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/afd7ea16-e295-37f0-84a8-fe2fdd0232ee"
);

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

let body = {
    "label": "ut",
    "input_type": "sit",
    "default_value": "rerum",
    "is_required": false,
    "is_conditional": true,
    "has_help_guide": false,
    "conditional_value": "rerum",
    "help_guide": "quo",
    "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: afd7ea16-e295-37f0-84a8-fe2fdd0232ee

Body Parameters

label   string   

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

input_type   string   

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

default_value   string  optional  

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

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: false

conditional_value   text  optional  

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

help_guide   string  optional  

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

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/c2ad9bec-e268-35c8-b8e5-efe0f595d949" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"id\",
    \"input_type\": \"aut\",
    \"default_value\": \"nulla\",
    \"is_required\": true,
    \"is_conditional\": false,
    \"has_help_guide\": true,
    \"conditional_value\": \"quibusdam\",
    \"help_guide\": \"dolore\",
    \"position\": 15
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/c2ad9bec-e268-35c8-b8e5-efe0f595d949';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'id',
            'input_type' => 'aut',
            'default_value' => 'nulla',
            'is_required' => true,
            'is_conditional' => false,
            'has_help_guide' => true,
            'conditional_value' => 'quibusdam',
            'help_guide' => 'dolore',
            'position' => 15,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/c2ad9bec-e268-35c8-b8e5-efe0f595d949"
);

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

let body = {
    "label": "id",
    "input_type": "aut",
    "default_value": "nulla",
    "is_required": true,
    "is_conditional": false,
    "has_help_guide": true,
    "conditional_value": "quibusdam",
    "help_guide": "dolore",
    "position": 15
};

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: c2ad9bec-e268-35c8-b8e5-efe0f595d949

Body Parameters

label   string  optional  

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

input_type   string  optional  

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

default_value   string  optional  

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

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: quibusdam

help_guide   string  optional  

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

position   integer  optional  

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

Delete

requires authentication

Delete a form field.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/c1c88341-6311-3cda-acbd-e33d8bfca2ac" \
    --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/c1c88341-6311-3cda-acbd-e33d8bfca2ac';
$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/c1c88341-6311-3cda-acbd-e33d8bfca2ac"
);

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: c1c88341-6311-3cda-acbd-e33d8bfca2ac

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: 19

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: repudiandae

sort_order   string  optional  

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

search   string  optional  

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

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\": \"ty\",
    \"save_service_plan_as\": \"SERVICE_PLAN_ARCHIVED\",
    \"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' => 'ty',
            'save_service_plan_as' => 'SERVICE_PLAN_ARCHIVED',
            '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": "ty",
    "save_service_plan_as": "SERVICE_PLAN_ARCHIVED",
    "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: ty

label   string   

Must not be greater than 191 characters. Example: ymbscxr

input_type   string  optional  
combine_input_value_collection   boolean  optional  

Example: true

save_service_plan_as   string  optional  

Example: SERVICE_PLAN_ARCHIVED

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/e706e688-eb50-356c-ae6b-be09ad46d40f" \
    --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/e706e688-eb50-356c-ae6b-be09ad46d40f';
$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/e706e688-eb50-356c-ae6b-be09ad46d40f"
);

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: e706e688-eb50-356c-ae6b-be09ad46d40f

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/731aeb4c-54db-3959-8eea-86eaaa70f3f8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"custom_fields\": \"mktetxwbskdkwrikkcsawqf\",
    \"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/731aeb4c-54db-3959-8eea-86eaaa70f3f8';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'custom_fields' => 'mktetxwbskdkwrikkcsawqf',
            '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/731aeb4c-54db-3959-8eea-86eaaa70f3f8"
);

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

let body = {
    "custom_fields": "mktetxwbskdkwrikkcsawqf",
    "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: 731aeb4c-54db-3959-8eea-86eaaa70f3f8

Body Parameters

custom_fields   string[]  optional  

Must have at least 0 items. Must not have more than 150 items. Example: mktetxwbskdkwrikkcsawqf

label   string   

Must not be greater than 191 characters. Example: zjsxzuulkzkcqc

input_type   string  optional  
combine_input_value_collection   boolean  optional  

Example: false

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/12dd2f1e-651a-3a3d-b445-415d7b1dadcf" \
    --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/12dd2f1e-651a-3a3d-b445-415d7b1dadcf';
$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/12dd2f1e-651a-3a3d-b445-415d7b1dadcf"
);

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: 12dd2f1e-651a-3a3d-b445-415d7b1dadcf

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/3ba75350-3a75-3c45-9936-7d497fe3a05f" \
    --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/3ba75350-3a75-3c45-9936-7d497fe3a05f';
$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/3ba75350-3a75-3c45-9936-7d497fe3a05f"
);

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: 3ba75350-3a75-3c45-9936-7d497fe3a05f

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: 4

page_size   integer  optional  

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

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: earum

search   string  optional  

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

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\": \"quia\"
}"
$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' => 'quia',
        ],
    ]
);
$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": "quia"
};

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: quia

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\": \"fuga\"
}"
$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' => 'fuga',
        ],
    ]
);
$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": "fuga"
};

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: fuga

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\": \"eum\"
}"
$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' => 'eum',
        ],
    ]
);
$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": "eum"
};

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: eum

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: 2

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: quis

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: odio

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\": \"corporis\"
}"
$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' => 'corporis',
        ],
    ]
);
$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": "corporis"
};

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: corporis

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\": \"voluptas\"
}"
$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' => 'voluptas',
        ],
    ]
);
$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": "voluptas"
};

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: voluptas

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\": \"repudiandae\"
}"
$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' => 'repudiandae',
        ],
    ]
);
$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": "repudiandae"
};

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: repudiandae

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/1617a9b0-9f12-3977-a110-1715d2463c5a/states/1ae3b5df-8c04-336f-b344-99b24da1cbb0" \
    --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/1617a9b0-9f12-3977-a110-1715d2463c5a/states/1ae3b5df-8c04-336f-b344-99b24da1cbb0';
$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/1617a9b0-9f12-3977-a110-1715d2463c5a/states/1ae3b5df-8c04-336f-b344-99b24da1cbb0"
);

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: 1617a9b0-9f12-3977-a110-1715d2463c5a

countryStateUuid   string   

Example: 1ae3b5df-8c04-336f-b344-99b24da1cbb0

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: 6

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: necessitatibus

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 (name, postal_code, cities). Example : home Example: hic

country_uuid   string  optional  

The UUID of country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 8e2e6202-a999-3d77-9d6f-36f89f72faca

country_state_uuids   integer  optional  

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

is_compound   string  optional  

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

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: rem

Show

requires authentication

Show a single tax.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/taxes/9d8e4658-9ffd-3a9c-add6-873a5449e994" \
    --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/9d8e4658-9ffd-3a9c-add6-873a5449e994';
$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/9d8e4658-9ffd-3a9c-add6-873a5449e994"
);

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: 9d8e4658-9ffd-3a9c-add6-873a5449e994

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\": \"39a09bd5-517a-3cf0-9b9c-91140a27ca1b\",
    \"country_state_uuids\": [
        \"doloribus\"
    ],
    \"name\": \"ipsum\",
    \"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' => '39a09bd5-517a-3cf0-9b9c-91140a27ca1b',
            'country_state_uuids' => [
                'doloribus',
            ],
            'name' => 'ipsum',
            '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": "39a09bd5-517a-3cf0-9b9c-91140a27ca1b",
    "country_state_uuids": [
        "doloribus"
    ],
    "name": "ipsum",
    "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: 39a09bd5-517a-3cf0-9b9c-91140a27ca1b

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: ipsum

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/adc1200e-bcc6-39d8-b5ba-8fc70c12f350" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"7058bfc9-15f3-3008-bae0-00cf36268365\",
    \"country_state_uuids\": [
        \"illo\"
    ],
    \"name\": \"aperiam\",
    \"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/adc1200e-bcc6-39d8-b5ba-8fc70c12f350';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => '7058bfc9-15f3-3008-bae0-00cf36268365',
            'country_state_uuids' => [
                'illo',
            ],
            'name' => 'aperiam',
            '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/adc1200e-bcc6-39d8-b5ba-8fc70c12f350"
);

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

let body = {
    "country_uuid": "7058bfc9-15f3-3008-bae0-00cf36268365",
    "country_state_uuids": [
        "illo"
    ],
    "name": "aperiam",
    "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: adc1200e-bcc6-39d8-b5ba-8fc70c12f350

Body Parameters

country_uuid   string   

The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 7058bfc9-15f3-3008-bae0-00cf36268365

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: aperiam

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/98669b52-3e44-3a61-a120-bec14db8ec0a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"265c6fde-68d9-3df6-8715-143da7228a49\",
    \"country_state_uuids\": [
        \"provident\"
    ],
    \"name\": \"dolorem\",
    \"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/98669b52-3e44-3a61-a120-bec14db8ec0a';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => '265c6fde-68d9-3df6-8715-143da7228a49',
            'country_state_uuids' => [
                'provident',
            ],
            'name' => 'dolorem',
            '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/98669b52-3e44-3a61-a120-bec14db8ec0a"
);

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

let body = {
    "country_uuid": "265c6fde-68d9-3df6-8715-143da7228a49",
    "country_state_uuids": [
        "provident"
    ],
    "name": "dolorem",
    "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: 98669b52-3e44-3a61-a120-bec14db8ec0a

Body Parameters

country_uuid   string  optional  

optional The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 265c6fde-68d9-3df6-8715-143da7228a49

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: dolorem

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/9a8b499a-e065-3cd6-999e-9c7d4fa70c01" \
    --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/9a8b499a-e065-3cd6-999e-9c7d4fa70c01';
$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/9a8b499a-e065-3cd6-999e-9c7d4fa70c01"
);

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: 9a8b499a-e065-3cd6-999e-9c7d4fa70c01

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: 18

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: culpa

sort_order   string  optional  

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

search   string  optional  

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

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/1c1f5fd4-92f3-31eb-83f5-824f6282f98e" \
    --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/1c1f5fd4-92f3-31eb-83f5-824f6282f98e';
$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/1c1f5fd4-92f3-31eb-83f5-824f6282f98e"
);

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: 1c1f5fd4-92f3-31eb-83f5-824f6282f98e

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/21222e13-07fd-32ec-aae4-8affe24ffb4e" \
    --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/21222e13-07fd-32ec-aae4-8affe24ffb4e';
$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/21222e13-07fd-32ec-aae4-8affe24ffb4e"
);

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: 21222e13-07fd-32ec-aae4-8affe24ffb4e

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/db2fa52f-6cb6-368d-b572-dcf130276d30" \
    --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/db2fa52f-6cb6-368d-b572-dcf130276d30';
$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/db2fa52f-6cb6-368d-b572-dcf130276d30"
);

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: db2fa52f-6cb6-368d-b572-dcf130276d30

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/03c49c9e-daff-39eb-b166-e897fa5457fb" \
    --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/03c49c9e-daff-39eb-b166-e897fa5457fb';
$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/03c49c9e-daff-39eb-b166-e897fa5457fb"
);

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: 03c49c9e-daff-39eb-b166-e897fa5457fb

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/cbb04629-c00b-3814-b761-491fbf975b6b/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/cbb04629-c00b-3814-b761-491fbf975b6b/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/cbb04629-c00b-3814-b761-491fbf975b6b/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: cbb04629-c00b-3814-b761-491fbf975b6b

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\": \"illum\"
}"
$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' => 'illum',
        ],
    ]
);
$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": "illum"
};

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: illum

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/9f207333-81c5-3596-99cc-55bcb15ad74d/corrupti" \
    --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/9f207333-81c5-3596-99cc-55bcb15ad74d/corrupti';
$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/9f207333-81c5-3596-99cc-55bcb15ad74d/corrupti"
);

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: 9f207333-81c5-3596-99cc-55bcb15ad74d

action   string   

Example: corrupti

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/itaque" \
    --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/itaque';
$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/itaque"
);

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: itaque

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/36318b72-aa01-39c6-9404-a4c0d610ec4f" \
    --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/36318b72-aa01-39c6-9404-a4c0d610ec4f';
$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/36318b72-aa01-39c6-9404-a4c0d610ec4f"
);

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: 36318b72-aa01-39c6-9404-a4c0d610ec4f

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/186c4b93-7fa5-3416-aff6-f124d644548d" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"credentials\": [
        \"eaque\"
    ],
    \"status_uuid\": \"df490beb-07b8-3017-ad94-17e855a3f076\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/186c4b93-7fa5-3416-aff6-f124d644548d';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'credentials' => [
                'eaque',
            ],
            'status_uuid' => 'df490beb-07b8-3017-ad94-17e855a3f076',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/186c4b93-7fa5-3416-aff6-f124d644548d"
);

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

let body = {
    "credentials": [
        "eaque"
    ],
    "status_uuid": "df490beb-07b8-3017-ad94-17e855a3f076"
};

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: 186c4b93-7fa5-3416-aff6-f124d644548d

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: df490beb-07b8-3017-ad94-17e855a3f076

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/139c0486-4080-3ed9-a6e1-ab3602ce2e9b" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"credentials\": [
        \"ullam\"
    ],
    \"status_uuid\": \"60d30ac8-f6fc-3cf7-af8d-55bc5787a517\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/139c0486-4080-3ed9-a6e1-ab3602ce2e9b';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'credentials' => [
                'ullam',
            ],
            'status_uuid' => '60d30ac8-f6fc-3cf7-af8d-55bc5787a517',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/139c0486-4080-3ed9-a6e1-ab3602ce2e9b"
);

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

let body = {
    "credentials": [
        "ullam"
    ],
    "status_uuid": "60d30ac8-f6fc-3cf7-af8d-55bc5787a517"
};

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: 139c0486-4080-3ed9-a6e1-ab3602ce2e9b

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: 60d30ac8-f6fc-3cf7-af8d-55bc5787a517

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/c661075e-7903-3009-936a-b4dc4d5ddb6e" \
    --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/c661075e-7903-3009-936a-b4dc4d5ddb6e';
$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/c661075e-7903-3009-936a-b4dc4d5ddb6e"
);

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: c661075e-7903-3009-936a-b4dc4d5ddb6e

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: 13

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: facere

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: modi

with_trashed   string  optional  

boolean To display soft deleted data as well. Example : true Example: et

category_uuids   string  optional  

string[] To filter symbols by category. Example : [3245d630-24fd-11ec-accd-e397aec85c7f, 3245d630-24fd-11ec-accd-e397aec85c7f] Example: sed

Show

requires authentication

Show a single company symbol.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/symbols/27d43eae-5b8f-3fae-b694-7ba205043efe" \
    --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/27d43eae-5b8f-3fae-b694-7ba205043efe';
$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/27d43eae-5b8f-3fae-b694-7ba205043efe"
);

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: 27d43eae-5b8f-3fae-b694-7ba205043efe

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=eum"\
    --form "source=consequatur"\
    --form "description=Consequatur repellendus quisquam est."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=dolores"\
    --form "icon_file=@/tmp/phpjwTyHO" 
$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' => 'eum'
            ],
            [
                'name' => 'source',
                'contents' => 'consequatur'
            ],
            [
                'name' => 'description',
                'contents' => 'Consequatur repellendus quisquam est.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'dolores'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpjwTyHO', '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', 'eum');
body.append('source', 'consequatur');
body.append('description', 'Consequatur repellendus quisquam est.');
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: eum

source   string   

The source of the symbol. Example : text Example: consequatur

description   string  optional  

optional The description of the symbol. Example : text Example: Consequatur repellendus quisquam est.

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/phpjwTyHO

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/57c26b1f-02b8-34bc-84b3-151ad29a0cfb" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=porro"\
    --form "source=dolor"\
    --form "description=Reprehenderit et aut repudiandae et."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=eos"\
    --form "icon_file=@/tmp/phpMbW4DN" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/57c26b1f-02b8-34bc-84b3-151ad29a0cfb';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'porro'
            ],
            [
                'name' => 'source',
                'contents' => 'dolor'
            ],
            [
                'name' => 'description',
                'contents' => 'Reprehenderit et aut repudiandae et.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'eos'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpMbW4DN', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/57c26b1f-02b8-34bc-84b3-151ad29a0cfb"
);

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

const body = new FormData();
body.append('name', 'porro');
body.append('source', 'dolor');
body.append('description', 'Reprehenderit et aut repudiandae et.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'eos');
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: 57c26b1f-02b8-34bc-84b3-151ad29a0cfb

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: porro

source   string   

The source of the symbol. Example : text Example: dolor

description   string  optional  

optional The description of the symbol. Example : text Example: Reprehenderit et aut repudiandae et.

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/phpMbW4DN

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/28f61d6d-268e-3faf-bacf-52a6743bd3b1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=perferendis"\
    --form "source=rerum"\
    --form "description=Optio et et inventore atque."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=odio"\
    --form "icon_file=@/tmp/phpUvRz0M" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/28f61d6d-268e-3faf-bacf-52a6743bd3b1';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'perferendis'
            ],
            [
                'name' => 'source',
                'contents' => 'rerum'
            ],
            [
                'name' => 'description',
                'contents' => 'Optio et et inventore atque.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'odio'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpUvRz0M', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/28f61d6d-268e-3faf-bacf-52a6743bd3b1"
);

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

const body = new FormData();
body.append('name', 'perferendis');
body.append('source', 'rerum');
body.append('description', 'Optio et et inventore atque.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'odio');
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: 28f61d6d-268e-3faf-bacf-52a6743bd3b1

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: perferendis

source   string   

The source of the symbol. Example : text Example: rerum

description   string  optional  

optional The description of the symbol. Example : text Example: Optio et et inventore 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/phpUvRz0M

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/4d9e516b-e0a6-3f4e-bc4f-25347b667121" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=modi"\
    --form "source=nostrum"\
    --form "description=Omnis nam ducimus repellendus dolore."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "icon_file=@/tmp/phpAwYX9M" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/4d9e516b-e0a6-3f4e-bc4f-25347b667121';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'modi'
            ],
            [
                'name' => 'source',
                'contents' => 'nostrum'
            ],
            [
                'name' => 'description',
                'contents' => 'Omnis nam ducimus repellendus dolore.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpAwYX9M', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/4d9e516b-e0a6-3f4e-bc4f-25347b667121"
);

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

const body = new FormData();
body.append('name', 'modi');
body.append('source', 'nostrum');
body.append('description', 'Omnis nam ducimus repellendus dolore.');
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: 4d9e516b-e0a6-3f4e-bc4f-25347b667121

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: modi

source   string   

The source of the symbol. Example : text Example: nostrum

description   string  optional  

optional The description of the symbol. Example : text Example: Omnis nam ducimus repellendus dolore.

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/phpAwYX9M

Delete

requires authentication

Delete a company symbol.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/e02f26e2-eddb-3906-b012-ffdcd4612038" \
    --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/e02f26e2-eddb-3906-b012-ffdcd4612038';
$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/e02f26e2-eddb-3906-b012-ffdcd4612038"
);

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: e02f26e2-eddb-3906-b012-ffdcd4612038

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/3a774be7-ae71-3f15-af92-e60b1f96a699" \
    --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/phpCBy9XL" \
    --form "photo_file=@/tmp/phpfF2S3L" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/support-request-upload/3a774be7-ae71-3f15-af92-e60b1f96a699';
$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/phpCBy9XL', 'r')
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpfF2S3L', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/support-request-upload/3a774be7-ae71-3f15-af92-e60b1f96a699"
);

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: 3a774be7-ae71-3f15-af92-e60b1f96a699

Body Parameters

screenshot_file   file   

Must be a file. Must be an image. Example: /tmp/phpCBy9XL

document_template_page_title   string   

The template page title. Example: Cover Letter

photo_file   file   

The photo of template page. Example: /tmp/phpfF2S3L

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: 3

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: voluptatibus

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: aut

Show

requires authentication

Show a single pest treated.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/45db170a-cb0a-33f2-ac01-e2e1f5a1b001" \
    --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/45db170a-cb0a-33f2-ac01-e2e1f5a1b001';
$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/45db170a-cb0a-33f2-ac01-e2e1f5a1b001"
);

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: 45db170a-cb0a-33f2-ac01-e2e1f5a1b001

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=sequi"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "pest_treated="\
    --form "photo_file=@/tmp/php97cjMN" 
$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' => 'sequi'
            ],
            [
                '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/php97cjMN', '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', 'sequi');
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: sequi

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/php97cjMN

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/27dcf152-2ffe-3c48-95ea-bbe1b28b60a6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=facilis"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phpeanqwP" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/27dcf152-2ffe-3c48-95ea-bbe1b28b60a6';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'facilis'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpeanqwP', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/27dcf152-2ffe-3c48-95ea-bbe1b28b60a6"
);

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

const body = new FormData();
body.append('name', 'facilis');
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: 27dcf152-2ffe-3c48-95ea-bbe1b28b60a6

Body Parameters

name   string   

The name of the pest treated. Example : Pest Treated 1 Example: facilis

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/phpeanqwP

Update

requires authentication

Update a pest treated.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/32f0cab3-f2b4-3854-9023-68709b0ab1dc" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=voluptates"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phpQsBDdQ" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/32f0cab3-f2b4-3854-9023-68709b0ab1dc';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'voluptates'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpQsBDdQ', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/32f0cab3-f2b4-3854-9023-68709b0ab1dc"
);

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

const body = new FormData();
body.append('name', 'voluptates');
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: 32f0cab3-f2b4-3854-9023-68709b0ab1dc

Body Parameters

name   string   

The name of the pest treated. Example : Pest Treated 1 Example: voluptates

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/phpQsBDdQ

Patch

requires authentication

Patch a company pest treated.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/faaca2fb-a549-3d74-ab11-29d270f9d6d6" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=nihil"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phph1AZRO" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/faaca2fb-a549-3d74-ab11-29d270f9d6d6';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'nihil'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phph1AZRO', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/faaca2fb-a549-3d74-ab11-29d270f9d6d6"
);

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

const body = new FormData();
body.append('name', 'nihil');
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: faaca2fb-a549-3d74-ab11-29d270f9d6d6

Body Parameters

name   string  optional  

optional The name of the pest treated. Example : Pest Treated 1 Example: nihil

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/phph1AZRO

Delete

requires authentication

Delete a pest treated.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/688b2a31-37d6-34e3-84d8-3b4253a2a2ce" \
    --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/688b2a31-37d6-34e3-84d8-3b4253a2a2ce';
$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/688b2a31-37d6-34e3-84d8-3b4253a2a2ce"
);

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: 688b2a31-37d6-34e3-84d8-3b4253a2a2ce

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: 4

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: cupiditate

sort_order   string  optional  

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

search   string  optional  

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

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\": \"ad\",
    \"description\": \"Aut modi assumenda dolor enim non.\"
}"
$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' => 'ad',
            'description' => 'Aut modi assumenda dolor enim non.',
        ],
    ]
);
$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": "ad",
    "description": "Aut modi assumenda dolor enim non."
};

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: ad

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Aut modi assumenda dolor enim non.

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\": \"quam\",
    \"description\": \"Nostrum tempore iste voluptatem aut enim esse.\"
}"
$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' => 'quam',
            'description' => 'Nostrum tempore iste voluptatem aut enim esse.',
        ],
    ]
);
$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": "quam",
    "description": "Nostrum tempore iste voluptatem aut enim esse."
};

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: quam

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Nostrum tempore iste voluptatem aut enim esse.

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\": \"cupiditate\",
    \"description\": \"Maxime consequuntur qui est.\"
}"
$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' => 'cupiditate',
            'description' => 'Maxime consequuntur qui est.',
        ],
    ]
);
$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": "cupiditate",
    "description": "Maxime consequuntur qui est."
};

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: cupiditate

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Maxime consequuntur qui est.

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/phpiXswTP" 
$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/phpiXswTP', '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/phpiXswTP

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\": \"distinctio\",
    \"description\": \"Nesciunt odit modi ipsum voluptatem accusamus rerum.\"
}"
$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' => 'distinctio',
            'description' => 'Nesciunt odit modi ipsum voluptatem accusamus rerum.',
        ],
    ]
);
$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": "distinctio",
    "description": "Nesciunt odit modi ipsum voluptatem accusamus rerum."
};

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: distinctio

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Nesciunt odit modi ipsum voluptatem accusamus rerum.

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\": \"quo\",
    \"description\": \"Repellat non voluptatum velit optio.\"
}"
$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' => 'quo',
            'description' => 'Repellat non voluptatum velit optio.',
        ],
    ]
);
$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": "quo",
    "description": "Repellat non voluptatum velit optio."
};

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: quo

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Repellat non voluptatum velit optio.

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\": \"vel\",
    \"description\": \"Sit illo et sint sed molestias deleniti sit et.\"
}"
$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' => 'vel',
            'description' => 'Sit illo et sint sed molestias deleniti sit et.',
        ],
    ]
);
$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": "vel",
    "description": "Sit illo et sint sed molestias deleniti sit et."
};

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: vel

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Sit illo et sint sed molestias deleniti sit et.

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: 12

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: dolores

sort_order   string  optional  

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

search   string  optional  

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

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\": \"1d7fc0a1-da45-3c12-9715-a1a07d1b314d\",
    \"title\": \"deserunt\",
    \"description\": \"Consectetur veritatis cum ut ut fugiat.\",
    \"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' => '1d7fc0a1-da45-3c12-9715-a1a07d1b314d',
            'title' => 'deserunt',
            'description' => 'Consectetur veritatis cum ut ut fugiat.',
            '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": "1d7fc0a1-da45-3c12-9715-a1a07d1b314d",
    "title": "deserunt",
    "description": "Consectetur veritatis cum ut ut fugiat.",
    "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: 1d7fc0a1-da45-3c12-9715-a1a07d1b314d

title   string   

The name of the proposal template. Example : Proposal Template 1 Example: deserunt

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Consectetur veritatis cum ut ut fugiat.

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/a9fff43f-9597-3225-bda0-29146cbf1a3a/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/a9fff43f-9597-3225-bda0-29146cbf1a3a/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/a9fff43f-9597-3225-bda0-29146cbf1a3a/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: a9fff43f-9597-3225-bda0-29146cbf1a3a

Show

requires authentication

Show a single proposal template.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/templates/16bc26de-aec6-3d76-ac1b-5f7c860561e6" \
    --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/16bc26de-aec6-3d76-ac1b-5f7c860561e6';
$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/16bc26de-aec6-3d76-ac1b-5f7c860561e6"
);

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: 16bc26de-aec6-3d76-ac1b-5f7c860561e6

Update

requires authentication

Update a proposal template.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/templates/7b6eb6ba-e73c-3345-ac06-66e95b870693" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"7420362f-7975-3980-b816-74e03aa65922\",
    \"title\": \"ut\",
    \"description\": \"Consequatur in ab rerum ratione excepturi.\",
    \"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/7b6eb6ba-e73c-3345-ac06-66e95b870693';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '7420362f-7975-3980-b816-74e03aa65922',
            'title' => 'ut',
            'description' => 'Consequatur in ab rerum ratione excepturi.',
            '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/7b6eb6ba-e73c-3345-ac06-66e95b870693"
);

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

let body = {
    "company_location_uuid": "7420362f-7975-3980-b816-74e03aa65922",
    "title": "ut",
    "description": "Consequatur in ab rerum ratione excepturi.",
    "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: 7b6eb6ba-e73c-3345-ac06-66e95b870693

Body Parameters

company_location_uuid   string   

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 7420362f-7975-3980-b816-74e03aa65922

title   string   

The name of the proposal template. Example : Proposal Template 1 Example: ut

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Consequatur in ab rerum ratione excepturi.

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/d2910792-b5b9-3eaf-8b00-825c127c2973" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"0c7ea738-fd18-3c5e-986d-052a6721d2ff\",
    \"title\": \"et\",
    \"description\": \"Error optio et sequi nihil sed perferendis quod.\",
    \"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/d2910792-b5b9-3eaf-8b00-825c127c2973';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '0c7ea738-fd18-3c5e-986d-052a6721d2ff',
            'title' => 'et',
            'description' => 'Error optio et sequi nihil sed perferendis quod.',
            '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/d2910792-b5b9-3eaf-8b00-825c127c2973"
);

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

let body = {
    "company_location_uuid": "0c7ea738-fd18-3c5e-986d-052a6721d2ff",
    "title": "et",
    "description": "Error optio et sequi nihil sed perferendis quod.",
    "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: d2910792-b5b9-3eaf-8b00-825c127c2973

Body Parameters

company_location_uuid   string  optional  

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0c7ea738-fd18-3c5e-986d-052a6721d2ff

title   string  optional  

The name of the proposal template. Example : Proposal Template 1 Example: et

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Error optio et sequi nihil sed perferendis quod.

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/66270286-8037-3fe6-b27e-66a42d963ebb" \
    --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/66270286-8037-3fe6-b27e-66a42d963ebb';
$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/66270286-8037-3fe6-b27e-66a42d963ebb"
);

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: 66270286-8037-3fe6-b27e-66a42d963ebb

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\": \"e4b493e4-d5ee-3a2c-b75a-facca55c7f89\",
    \"company_location_uuid\": \"07df1b04-ebd3-3978-a6b9-a34f56cfbb55\",
    \"media_source_uuid\": \"06253791-aa99-3871-bcef-64220c308e63\",
    \"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' => 'e4b493e4-d5ee-3a2c-b75a-facca55c7f89',
            'company_location_uuid' => '07df1b04-ebd3-3978-a6b9-a34f56cfbb55',
            'media_source_uuid' => '06253791-aa99-3871-bcef-64220c308e63',
            '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": "e4b493e4-d5ee-3a2c-b75a-facca55c7f89",
    "company_location_uuid": "07df1b04-ebd3-3978-a6b9-a34f56cfbb55",
    "media_source_uuid": "06253791-aa99-3871-bcef-64220c308e63",
    "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: 13

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: dolores

sort_order   string  optional  

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

search   string  optional  

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

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: e4b493e4-d5ee-3a2c-b75a-facca55c7f89

companies_uuid   object  optional  
company_location_uuid   string  optional  

Must be a valid UUID. Example: 07df1b04-ebd3-3978-a6b9-a34f56cfbb55

company_locations_uuid   object  optional  
media_source_uuid   string  optional  

Must be a valid UUID. Example: 06253791-aa99-3871-bcef-64220c308e63

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=et"\
    --form "description=Ab quasi in eveniet a consectetur."\
    --form "directory=proposal-template"\
    --form "type=document"\
    --form "fileUpload=@/tmp/phpJSUfvN" 
$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' => 'et'
            ],
            [
                'name' => 'description',
                'contents' => 'Ab quasi in eveniet a consectetur.'
            ],
            [
                'name' => 'directory',
                'contents' => 'proposal-template'
            ],
            [
                'name' => 'type',
                'contents' => 'document'
            ],
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phpJSUfvN', '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', 'et');
body.append('description', 'Ab quasi in eveniet a consectetur.');
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: et

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Ab quasi in eveniet a consectetur.

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/phpJSUfvN

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\": \"nihil\",
    \"description\": \"Voluptas deserunt neque ipsum magnam.\"
}"
$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' => 'nihil',
            'description' => 'Voluptas deserunt neque ipsum magnam.',
        ],
    ]
);
$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": "nihil",
    "description": "Voluptas deserunt neque ipsum magnam."
};

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: nihil

description   string  optional  

The description of the media item. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Voluptas deserunt neque ipsum magnam.

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\": \"accusantium\",
    \"description\": \"Adipisci et reprehenderit cum optio.\"
}"
$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' => 'accusantium',
            'description' => 'Adipisci et reprehenderit cum optio.',
        ],
    ]
);
$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": "accusantium",
    "description": "Adipisci et reprehenderit cum optio."
};

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: accusantium

description   string  optional  

The description of the media item. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Adipisci et reprehenderit cum optio.

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: 13

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: nisi

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: sunt

Show

requires authentication

Show a single company product.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/products/cfd0120f-a286-30c7-80b7-79f14ad4149e" \
    --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/cfd0120f-a286-30c7-80b7-79f14ad4149e';
$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/cfd0120f-a286-30c7-80b7-79f14ad4149e"
);

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: cfd0120f-a286-30c7-80b7-79f14ad4149e

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\": \"incidunt\",
    \"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' => 'incidunt',
            '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": "incidunt",
    "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: incidunt

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/b2a33285-3bc7-318c-bdb2-a12855a38530" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"eum\",
    \"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/b2a33285-3bc7-318c-bdb2-a12855a38530';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'eum',
            '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/b2a33285-3bc7-318c-bdb2-a12855a38530"
);

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

let body = {
    "name": "eum",
    "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: b2a33285-3bc7-318c-bdb2-a12855a38530

Body Parameters

name   string   

The name of the product. Example : Product 1 Example: eum

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/a9c2dc6d-04fc-30ca-b39c-24738288b926" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"iste\",
    \"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/a9c2dc6d-04fc-30ca-b39c-24738288b926';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'iste',
            '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/a9c2dc6d-04fc-30ca-b39c-24738288b926"
);

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

let body = {
    "name": "iste",
    "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: a9c2dc6d-04fc-30ca-b39c-24738288b926

Body Parameters

name   string  optional  

optional The name of the product. Example : Product 1 Example: iste

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/c6cab74b-d6f4-379c-abb9-d93657aea366" \
    --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/c6cab74b-d6f4-379c-abb9-d93657aea366';
$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/c6cab74b-d6f4-379c-abb9-d93657aea366"
);

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: c6cab74b-d6f4-379c-abb9-d93657aea366

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: 20

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: beatae

sort_order   string  optional  

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

search   string  optional  

The general search, it will find matching string. Example : "Pest Control" Example: eaque

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=vitae"\
    --form "description=Itaque totam sit rerum ad enim delectus."\
    --form "directory=proposal-template"\
    --form "type=document"\
    --form "fileUpload=@/tmp/phpriSrGM" 
$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' => 'vitae'
            ],
            [
                'name' => 'description',
                'contents' => 'Itaque totam sit rerum ad enim delectus.'
            ],
            [
                'name' => 'directory',
                'contents' => 'proposal-template'
            ],
            [
                'name' => 'type',
                'contents' => 'document'
            ],
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phpriSrGM', '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', 'vitae');
body.append('description', 'Itaque totam sit rerum ad enim delectus.');
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: vitae

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Itaque totam sit rerum ad enim delectus.

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/phpriSrGM

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:\\/\\/boyer.net\\/a-nihil-inventore-porro-consectetur-sit.html\"
}"
$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://boyer.net/a-nihil-inventore-porro-consectetur-sit.html',
        ],
    ]
);
$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:\/\/boyer.net\/a-nihil-inventore-porro-consectetur-sit.html"
};

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://boyer.net/a-nihil-inventore-porro-consectetur-sit.html

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/5321a37d-e167-3172-9517-93b69614e51c" \
    --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/5321a37d-e167-3172-9517-93b69614e51c';
$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/5321a37d-e167-3172-9517-93b69614e51c"
);

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: 5321a37d-e167-3172-9517-93b69614e51c

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/56c9e999-df6d-3dc7-a6d1-8481294058ce/states" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/countries/56c9e999-df6d-3dc7-a6d1-8481294058ce/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/56c9e999-df6d-3dc7-a6d1-8481294058ce/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: 56c9e999-df6d-3dc7-a6d1-8481294058ce

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\": false
}"
$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' => false,
        ],
    ]
);
$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": false
};

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: 19

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: fugit

sort_order   string  optional  

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

search   string  optional  

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

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: et

Body Parameters

include_fields   string[]  optional  
Must be one of:
  • user_progress
  • solutions
ignore_cached   boolean  optional  

Example: false

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\": \"ab\",
    \"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' => 'ab',
            '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": "ab",
    "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: ab

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\": \"omnis\",
    \"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' => 'omnis',
            '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": "omnis",
    "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: omnis

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: est

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\": \"maxime\",
    \"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' => 'maxime',
            '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": "maxime",
    "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: maxime

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: 17

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: voluptatem

search   string  optional  

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

Show

requires authentication

Show a single solution.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/b40d1340-5e0b-3737-8e70-ecdc42a03dee" \
    --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/b40d1340-5e0b-3737-8e70-ecdc42a03dee';
$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/b40d1340-5e0b-3737-8e70-ecdc42a03dee"
);

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: b40d1340-5e0b-3737-8e70-ecdc42a03dee

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\": 9,
    \"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' => 9,
            '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": 9,
    "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: 9

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/c1de1587-2ae4-3e68-9e0c-461fd898dbde" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 20,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/c1de1587-2ae4-3e68-9e0c-461fd898dbde';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 20,
            '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/c1de1587-2ae4-3e68-9e0c-461fd898dbde"
);

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

let body = {
    "rate": 20,
    "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: c1de1587-2ae4-3e68-9e0c-461fd898dbde

Body Parameters

rate   integer   

The name of the solution. Example : 5 Example: 20

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/91ba2189-c261-3879-9d50-5d7c07df3b11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 16,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/91ba2189-c261-3879-9d50-5d7c07df3b11';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 16,
            '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/91ba2189-c261-3879-9d50-5d7c07df3b11"
);

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

let body = {
    "rate": 16,
    "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: 91ba2189-c261-3879-9d50-5d7c07df3b11

Body Parameters

rate   integer   

The name of the solution. Example : 5 Example: 16

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/8edafb7d-fb29-3aa7-9e99-1fd57954f066" \
    --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/8edafb7d-fb29-3aa7-9e99-1fd57954f066';
$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/8edafb7d-fb29-3aa7-9e99-1fd57954f066"
);

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: 8edafb7d-fb29-3aa7-9e99-1fd57954f066

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\": \"a4300b8c-50c1-3ae5-9737-108f95b76acb\",
    \"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' => 'a4300b8c-50c1-3ae5-9737-108f95b76acb',
            '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": "a4300b8c-50c1-3ae5-9737-108f95b76acb",
    "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: a4300b8c-50c1-3ae5-9737-108f95b76acb

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: 19

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: ut

sort_order   string  optional  

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

search   string  optional  

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

with_trashed   string  optional  

boolean To display soft deleted data as well. Example : true Example: veniam

assignment   string  optional  

To filter data by assignment. Example : CUSTOMER_ADDRESS Example: facilis

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/053a706c-37f0-30ba-a70a-953c027b674c" \
    --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/053a706c-37f0-30ba-a70a-953c027b674c';
$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/053a706c-37f0-30ba-a70a-953c027b674c"
);

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: 053a706c-37f0-30ba-a70a-953c027b674c

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\": \"deserunt\",
    \"assignment\": \"temporibus\",
    \"company_custom_fields\": [
        \"eveniet\"
    ]
}"
$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' => 'deserunt',
            'assignment' => 'temporibus',
            'company_custom_fields' => [
                'eveniet',
            ],
        ],
    ]
);
$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": "deserunt",
    "assignment": "temporibus",
    "company_custom_fields": [
        "eveniet"
    ]
};

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: deserunt

assignment   enum  optional  

CUSTOMER|CUSTOMER_ADDRESS|MY_ACCOUNT|COMPANY|COMPANY_LOCATION required The assignment of the custom field group. Example : CUSTOMER Example: temporibus

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/52eede04-6ea7-3eb8-8668-a66f7af046ee" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"architecto\",
    \"assignment\": \"itaque\",
    \"company_custom_fields\": [
        \"ut\"
    ],
    \"deleted_custom_field_uuids\": [
        \"facilis\"
    ]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/52eede04-6ea7-3eb8-8668-a66f7af046ee';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'architecto',
            'assignment' => 'itaque',
            'company_custom_fields' => [
                'ut',
            ],
            'deleted_custom_field_uuids' => [
                'facilis',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/52eede04-6ea7-3eb8-8668-a66f7af046ee"
);

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

let body = {
    "name": "architecto",
    "assignment": "itaque",
    "company_custom_fields": [
        "ut"
    ],
    "deleted_custom_field_uuids": [
        "facilis"
    ]
};

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: 52eede04-6ea7-3eb8-8668-a66f7af046ee

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: architecto

assignment   enum  optional  

CUSTOMER|CUSTOMER_ADDRESS|MY_ACCOUNT|COMPANY|COMPANY_LOCATION required The assignment of the custom field group. Example : CUSTOMER Example: itaque

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/bfa63f86-5e08-3b9e-9096-f492067b18e4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"numquam\",
    \"assignment\": \"architecto\",
    \"company_custom_fields\": [
        \"corporis\"
    ],
    \"deleted_custom_field_uuids\": [
        \"sunt\"
    ]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/bfa63f86-5e08-3b9e-9096-f492067b18e4';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'numquam',
            'assignment' => 'architecto',
            'company_custom_fields' => [
                'corporis',
            ],
            'deleted_custom_field_uuids' => [
                'sunt',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/bfa63f86-5e08-3b9e-9096-f492067b18e4"
);

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

let body = {
    "name": "numquam",
    "assignment": "architecto",
    "company_custom_fields": [
        "corporis"
    ],
    "deleted_custom_field_uuids": [
        "sunt"
    ]
};

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: bfa63f86-5e08-3b9e-9096-f492067b18e4

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: numquam

assignment   enum  optional  

CUSTOMER|CUSTOMER_ADDRESS|MY_ACCOUNT|COMPANY|COMPANY_LOCATION required The assignment of the custom field group. Example : CUSTOMER Example: architecto

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/ab3767c2-0ee7-3f61-9208-ff2e70812eb5" \
    --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/ab3767c2-0ee7-3f61-9208-ff2e70812eb5';
$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/ab3767c2-0ee7-3f61-9208-ff2e70812eb5"
);

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: ab3767c2-0ee7-3f61-9208-ff2e70812eb5

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:\\/\\/sawayn.biz\\/dolores-natus-molestiae-dolorum-autem-quidem\"
}"
$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://sawayn.biz/dolores-natus-molestiae-dolorum-autem-quidem',
        ],
    ]
);
$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:\/\/sawayn.biz\/dolores-natus-molestiae-dolorum-autem-quidem"
};

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://sawayn.biz/dolores-natus-molestiae-dolorum-autem-quidem

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: 9

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: rerum

sort_order   string  optional  

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

search   string  optional  

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

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\": \"et\",
    \"description\": \"Non qui ab molestias facere dignissimos eius tenetur.\",
    \"line_item_values\": \"explicabo\"
}"
$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' => 'et',
            'description' => 'Non qui ab molestias facere dignissimos eius tenetur.',
            'line_item_values' => 'explicabo',
        ],
    ]
);
$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": "et",
    "description": "Non qui ab molestias facere dignissimos eius tenetur.",
    "line_item_values": "explicabo"
};

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: et

description   string   

The description of the line item. Example : "Termite Pesticide" Example: Non qui ab molestias facere dignissimos eius tenetur.

line_item_values   string   

The data of the line item. Example : {"price": [100, 100]} Example: explicabo

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\": \"in\",
    \"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' => 'in',
            '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": "in",
    "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: in

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\": \"illo\",
    \"description\": \"Qui sint possimus ut sed mollitia incidunt.\",
    \"line_item_values\": \"totam\"
}"
$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' => 'illo',
            'description' => 'Qui sint possimus ut sed mollitia incidunt.',
            'line_item_values' => 'totam',
        ],
    ]
);
$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": "illo",
    "description": "Qui sint possimus ut sed mollitia incidunt.",
    "line_item_values": "totam"
};

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: illo

description   string  optional  

The description of the line item. Example : "Termite Pesticide" Example: Qui sint possimus ut sed mollitia incidunt.

line_item_values   string   

The data of the line item. Example : {"price": [100, 100]} Example: totam

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\": \"ut\",
    \"description\": \"Modi nemo fuga ut beatae blanditiis eius.\",
    \"line_item_values\": \"voluptate\"
}"
$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' => 'ut',
            'description' => 'Modi nemo fuga ut beatae blanditiis eius.',
            'line_item_values' => 'voluptate',
        ],
    ]
);
$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": "ut",
    "description": "Modi nemo fuga ut beatae blanditiis eius.",
    "line_item_values": "voluptate"
};

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: ut

description   string  optional  

The description of the line item. Example : "Termite Pesticide" Example: Modi nemo fuga ut beatae blanditiis eius.

line_item_values   string   

The data of the line item. Example : {"price": [100, 100]} Example: voluptate

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: 5

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: commodi

sort_order   string  optional  

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

search   string  optional  

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

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\": \"quo\"
}"
$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' => 'quo',
        ],
    ]
);
$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": "quo"
};

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: quo

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\": \"vitae\"
}"
$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' => 'vitae',
        ],
    ]
);
$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": "vitae"
};

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: vitae

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\": \"doloremque\"
}"
$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' => 'doloremque',
        ],
    ]
);
$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": "doloremque"
};

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: doloremque

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: 16

page_size   integer  optional  

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

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: in

search   string  optional  

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

filter_by_uuids   string  optional  

string[] To fitler by selected uuids. Example : [uuid, uuid-2] Example: harum

groups   string  optional  

string[] To fitler by selected groups. Example : [dashboard, sales] Example: unde

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/8558ce9c-c57f-3db0-abe8-23e686088a92" \
    --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/8558ce9c-c57f-3db0-abe8-23e686088a92';
$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/8558ce9c-c57f-3db0-abe8-23e686088a92"
);

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: 8558ce9c-c57f-3db0-abe8-23e686088a92

Delete

requires authentication

Delete a report template.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/reports/templates/9ec8097d-0480-3ee7-ab43-b4c46683858f" \
    --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/9ec8097d-0480-3ee7-ab43-b4c46683858f';
$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/9ec8097d-0480-3ee7-ab43-b4c46683858f"
);

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: 9ec8097d-0480-3ee7-ab43-b4c46683858f

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: 12

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: sequi

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: quas

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/6872bede-17a5-3c4c-8074-3a698b8df59f" \
    --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/6872bede-17a5-3c4c-8074-3a698b8df59f';
$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/6872bede-17a5-3c4c-8074-3a698b8df59f"
);

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: 6872bede-17a5-3c4c-8074-3a698b8df59f

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/phpiE1zDO" 
$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/phpiE1zDO', '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/phpiE1zDO

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/phprQGJdN" 
$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/phprQGJdN', '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/phprQGJdN

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/phpPldXAN" 
$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/phpPldXAN', '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/phpPldXAN

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/phpDGYRPO" 
$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/phpDGYRPO', '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/phpDGYRPO

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\": [
        \"alias\"
    ],
    \"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' => [
                'alias',
            ],
            '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": [
        "alias"
    ],
    "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/d8785fc1-124e-319c-b829-742580fb7f01" \
    --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/d8785fc1-124e-319c-b829-742580fb7f01';
$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/d8785fc1-124e-319c-b829-742580fb7f01"
);

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: d8785fc1-124e-319c-b829-742580fb7f01

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/f716f708-9cd3-3437-bce4-f094eb3d30fc" \
    --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/f716f708-9cd3-3437-bce4-f094eb3d30fc';
$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/f716f708-9cd3-3437-bce4-f094eb3d30fc"
);

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: f716f708-9cd3-3437-bce4-f094eb3d30fc

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/a154a611-c83c-31c4-a77f-8d81431cdfd5" \
    --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/a154a611-c83c-31c4-a77f-8d81431cdfd5';
$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/a154a611-c83c-31c4-a77f-8d81431cdfd5"
);

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: a154a611-c83c-31c4-a77f-8d81431cdfd5

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: 20

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: ad

sort_order   string  optional  

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

search   string  optional  

The general search, it will find matching string. Example : "Categories" Example: quia

name   string  optional  

The name of import type. Example : "Categories" Example: est

code   string  optional  

The code of import type. Example : "categories" Example: non

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/26fae719-b741-3791-a4ed-b0edf1841861/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/26fae719-b741-3791-a4ed-b0edf1841861/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/26fae719-b741-3791-a4ed-b0edf1841861/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: 26fae719-b741-3791-a4ed-b0edf1841861

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:\\/\\/schulist.net\\/sit-in-necessitatibus-non-consequatur-aliquid-nihil-reprehenderit.html\",
    \"proposal_pdf_url\": \"http:\\/\\/legros.com\\/accusamus-doloribus-aut-qui-eum-reiciendis\",
    \"auth_code\": \"qui\"
}"
$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://schulist.net/sit-in-necessitatibus-non-consequatur-aliquid-nihil-reprehenderit.html',
            'proposal_pdf_url' => 'http://legros.com/accusamus-doloribus-aut-qui-eum-reiciendis',
            'auth_code' => 'qui',
        ],
    ]
);
$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:\/\/schulist.net\/sit-in-necessitatibus-non-consequatur-aliquid-nihil-reprehenderit.html",
    "proposal_pdf_url": "http:\/\/legros.com\/accusamus-doloribus-aut-qui-eum-reiciendis",
    "auth_code": "qui"
};

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://schulist.net/sit-in-necessitatibus-non-consequatur-aliquid-nihil-reprehenderit.html

proposal_pdf_url   string   

The pdf file url. Example: http://legros.com/accusamus-doloribus-aut-qui-eum-reiciendis

auth_code   string  optional  

Example: qui

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:\\/\\/rogahn.com\\/tempora-a-nemo-ex-temporibus-tempora-sed-impedit.html\",
    \"proposal_pdf_url\": \"http:\\/\\/www.mclaughlin.com\\/minima-a-ratione-incidunt-temporibus.html\"
}"
$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://rogahn.com/tempora-a-nemo-ex-temporibus-tempora-sed-impedit.html',
            'proposal_pdf_url' => 'http://www.mclaughlin.com/minima-a-ratione-incidunt-temporibus.html',
        ],
    ]
);
$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:\/\/rogahn.com\/tempora-a-nemo-ex-temporibus-tempora-sed-impedit.html",
    "proposal_pdf_url": "http:\/\/www.mclaughlin.com\/minima-a-ratione-incidunt-temporibus.html"
};

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://rogahn.com/tempora-a-nemo-ex-temporibus-tempora-sed-impedit.html

proposal_pdf_url   string   

The pdf file url. Example: http://www.mclaughlin.com/minima-a-ratione-incidunt-temporibus.html

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=1.1"\
    --form "documentFile=@/tmp/phpXqTpeO" 
$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' => '1.1'
            ],
            [
                'name' => 'documentFile',
                'contents' => fopen('/tmp/phpXqTpeO', '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', '1.1');
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/phpXqTpeO

documentIndex   number  optional  

The document index number. Example : 1 Example: 1.1

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\": \"debitis\"
}"
$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' => 'debitis',
        ],
    ]
);
$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": "debitis"
};

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: debitis

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-09-24T05:02:00\",
    \"date_range_end\": \"2096-04-28\",
    \"timezone\": \"Africa\\/Juba\"
}"
$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-09-24T05:02:00',
            'date_range_end' => '2096-04-28',
            'timezone' => 'Africa/Juba',
        ],
    ]
);
$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-09-24T05:02:00",
    "date_range_end": "2096-04-28",
    "timezone": "Africa\/Juba"
};

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: 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: possimus

sort_order   string  optional  

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

search   string  optional  

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

search_by   string  optional  

The specific field to search within. Options: customer_name, title, description. Example : customer_name Example: nihil

company_location_uuid   string  optional  

The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 596d4492-c479-35e6-b3a8-534a4a176930

company_location_uuids   string  optional  

string[] The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: quo

status_uuid   string  optional  

string[] The UUID of proposal status. Example : ["815d3d9c-f371-3781-8456-7e6954b5b0f5"] Example: c06e0db5-bde1-3d07-b8f9-8a81ab47d0bd

customer_uuid   string  optional  

The UUID of a customer. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0e65be4a-41af-3ade-acc2-0647668c246b

include_fields   string  optional  

string[] Optionally include related data for the proposal. Example : "company" Example: necessitatibus

user_uuid   string  optional  

Filter by the user that created proposals. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: b521104e-474d-3983-a700-26a367a591a4

timezone   string  optional  

Optional timezone for date filtering. Falls back to user's favorite location timezone, then MST. Example : "America/New_York" Example: Australia/Lord_Howe

date_range_start   string  optional  

Start date for filtering proposals. Example : "2024-08-01" Example: quis

date_range_end   string  optional  

End date for filtering proposals. Example : "2024-08-13" Example: cum

date_range_type   string  optional  

Type of date to filter by. Options: created_at, updated_at. Example : "created_at" Example: aut

Body Parameters

include_fields   string[]  optional  
ignore_cached   boolean  optional  

Example: true

date_range_start   string  optional  

Must be a valid date. Example: 2025-09-24T05:02:00

date_range_end   string  optional  

Must be a valid date. Must be a date after or equal to date_range_start. Example: 2096-04-28

timezone   string  optional  

Must be a valid time zone, such as Africa/Accra. Example: Africa/Juba

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: 18

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: exercitationem

sort_order   string  optional  

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

search   string  optional  

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

company_location_uuid   string  optional  

The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 122acee1-38ff-3f28-8319-6446c9418c02

company_location_uuids   string  optional  

string[] The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: assumenda

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 36ff45ee-64ab-39c4-8e93-b181a1c2b71a

customer_uuid   string  optional  

The UUID of a customer. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: f7bfead1-50ad-367b-8728-c4adbd9d135e

include_fields   string  optional  

string[] Optionally include related data for the proposal. Example : "company" Example: est

user_uuid   string  optional  

Filter by the user that created proposals. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 1eaac037-218f-317d-b4f2-97c6fac9f5f5

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: 8

page_size   integer  optional  

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

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: deserunt

search   string  optional  

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

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/9ba99fb9-98cf-36bc-b0f0-16a6f9a89652/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/9ba99fb9-98cf-36bc-b0f0-16a6f9a89652/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/9ba99fb9-98cf-36bc-b0f0-16a6f9a89652/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: 9ba99fb9-98cf-36bc-b0f0-16a6f9a89652

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/e46f1c2c-6e12-3225-ab2d-e4d457e9069d/at" \
    --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/e46f1c2c-6e12-3225-ab2d-e4d457e9069d/at';
$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/e46f1c2c-6e12-3225-ab2d-e4d457e9069d/at"
);

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: e46f1c2c-6e12-3225-ab2d-e4d457e9069d

action   string   

Example: at

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\": \"voluptatem\",
    \"description\": \"Pariatur sed ipsa iusto enim nobis nam ea.\",
    \"company_location_uuid\": \"f680281e-4d2d-3662-8883-4d6ce6c51ad4\",
    \"customer_uuid\": \"71ea01f8-db69-35d7-8ece-b98b6e330449\",
    \"customer_address_uuid\": \"4dea6822-c463-364b-93d4-83dbb2e35523\",
    \"status_uuid\": \"5da1dff6-4029-371d-bd14-1db18431f458\",
    \"service_plan_uuids\": [
        \"quia\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"b21afdb3-be6b-3ec0-ba13-b6da581c024a\"
}"
$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' => 'voluptatem',
            'description' => 'Pariatur sed ipsa iusto enim nobis nam ea.',
            'company_location_uuid' => 'f680281e-4d2d-3662-8883-4d6ce6c51ad4',
            'customer_uuid' => '71ea01f8-db69-35d7-8ece-b98b6e330449',
            'customer_address_uuid' => '4dea6822-c463-364b-93d4-83dbb2e35523',
            'status_uuid' => '5da1dff6-4029-371d-bd14-1db18431f458',
            'service_plan_uuids' => [
                'quia',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => 'b21afdb3-be6b-3ec0-ba13-b6da581c024a',
        ],
    ]
);
$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": "voluptatem",
    "description": "Pariatur sed ipsa iusto enim nobis nam ea.",
    "company_location_uuid": "f680281e-4d2d-3662-8883-4d6ce6c51ad4",
    "customer_uuid": "71ea01f8-db69-35d7-8ece-b98b6e330449",
    "customer_address_uuid": "4dea6822-c463-364b-93d4-83dbb2e35523",
    "status_uuid": "5da1dff6-4029-371d-bd14-1db18431f458",
    "service_plan_uuids": [
        "quia"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "b21afdb3-be6b-3ec0-ba13-b6da581c024a"
};

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: voluptatem

description   string  optional  

The paragraph describing the proposal. Example: Pariatur sed ipsa iusto enim nobis nam ea.

company_location_uuid   string   

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: f680281e-4d2d-3662-8883-4d6ce6c51ad4

customer_uuid   string   

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 71ea01f8-db69-35d7-8ece-b98b6e330449

customer_address_uuid   string   

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 4dea6822-c463-364b-93d4-83dbb2e35523

status_uuid   string   

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 5da1dff6-4029-371d-bd14-1db18431f458

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: b21afdb3-be6b-3ec0-ba13-b6da581c024a

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/phpTLWlFO" 
$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/phpTLWlFO', '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/phpTLWlFO

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\": \"et\",
    \"description\": \"Adipisci sed maxime dolor cupiditate doloremque corporis quia.\",
    \"company_location_uuid\": \"9d3c8194-af22-3eef-b835-383cf965c69d\",
    \"customer_uuid\": \"8a2cf95d-5aa1-3382-99f0-7b2913be682e\",
    \"customer_address_uuid\": \"357d4357-c26f-3f30-98c6-4b0077866c7e\",
    \"status_uuid\": \"81dbbe26-7ef6-31b3-8371-98259d4f3d13\",
    \"service_plan_uuids\": [
        \"quia\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"1379bf3e-f3a1-3a1c-97f0-9f0262d67316\"
}"
$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' => 'et',
            'description' => 'Adipisci sed maxime dolor cupiditate doloremque corporis quia.',
            'company_location_uuid' => '9d3c8194-af22-3eef-b835-383cf965c69d',
            'customer_uuid' => '8a2cf95d-5aa1-3382-99f0-7b2913be682e',
            'customer_address_uuid' => '357d4357-c26f-3f30-98c6-4b0077866c7e',
            'status_uuid' => '81dbbe26-7ef6-31b3-8371-98259d4f3d13',
            'service_plan_uuids' => [
                'quia',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => '1379bf3e-f3a1-3a1c-97f0-9f0262d67316',
        ],
    ]
);
$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": "et",
    "description": "Adipisci sed maxime dolor cupiditate doloremque corporis quia.",
    "company_location_uuid": "9d3c8194-af22-3eef-b835-383cf965c69d",
    "customer_uuid": "8a2cf95d-5aa1-3382-99f0-7b2913be682e",
    "customer_address_uuid": "357d4357-c26f-3f30-98c6-4b0077866c7e",
    "status_uuid": "81dbbe26-7ef6-31b3-8371-98259d4f3d13",
    "service_plan_uuids": [
        "quia"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "1379bf3e-f3a1-3a1c-97f0-9f0262d67316"
};

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: et

description   string  optional  

The paragraph describing the proposal. Example: Adipisci sed maxime dolor cupiditate doloremque corporis quia.

company_location_uuid   string  optional  

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 9d3c8194-af22-3eef-b835-383cf965c69d

customer_uuid   string  optional  

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 8a2cf95d-5aa1-3382-99f0-7b2913be682e

customer_address_uuid   string  optional  

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 357d4357-c26f-3f30-98c6-4b0077866c7e

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 81dbbe26-7ef6-31b3-8371-98259d4f3d13

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: 1379bf3e-f3a1-3a1c-97f0-9f0262d67316

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\": \"387ae4b0-104f-3b32-8bc0-f22e43b5d758\",
    \"customer_uuid\": \"489f6031-7422-37ff-a1b5-3a5e883b32b1\",
    \"customer_address_uuid\": \"453a74cf-bd18-30e5-b7f6-f3a9af1b408d\",
    \"status_uuid\": \"082ec1e3-5bcf-38fc-aca0-0a9fd14dbe1f\",
    \"service_plan_uuids\": [
        \"excepturi\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"c5efc3ef-480c-3551-ab45-0009426f18cd\",
    \"expire_at\": \"2025-09-24T05:02:00\"
}"
$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' => '387ae4b0-104f-3b32-8bc0-f22e43b5d758',
            'customer_uuid' => '489f6031-7422-37ff-a1b5-3a5e883b32b1',
            'customer_address_uuid' => '453a74cf-bd18-30e5-b7f6-f3a9af1b408d',
            'status_uuid' => '082ec1e3-5bcf-38fc-aca0-0a9fd14dbe1f',
            'service_plan_uuids' => [
                'excepturi',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => 'c5efc3ef-480c-3551-ab45-0009426f18cd',
            'expire_at' => '2025-09-24T05:02:00',
        ],
    ]
);
$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": "387ae4b0-104f-3b32-8bc0-f22e43b5d758",
    "customer_uuid": "489f6031-7422-37ff-a1b5-3a5e883b32b1",
    "customer_address_uuid": "453a74cf-bd18-30e5-b7f6-f3a9af1b408d",
    "status_uuid": "082ec1e3-5bcf-38fc-aca0-0a9fd14dbe1f",
    "service_plan_uuids": [
        "excepturi"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "c5efc3ef-480c-3551-ab45-0009426f18cd",
    "expire_at": "2025-09-24T05:02:00"
};

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: 387ae4b0-104f-3b32-8bc0-f22e43b5d758

customer_uuid   string   

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 489f6031-7422-37ff-a1b5-3a5e883b32b1

customer_address_uuid   string   

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 453a74cf-bd18-30e5-b7f6-f3a9af1b408d

status_uuid   string   

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 082ec1e3-5bcf-38fc-aca0-0a9fd14dbe1f

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: c5efc3ef-480c-3551-ab45-0009426f18cd

include_fields   object  optional  
expire_at   string  optional  

Must be a valid date. Example: 2025-09-24T05:02:00

Update

requires authentication

Update a proposal activity entry

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/a8b75242-c3f4-3ab4-ba1a-f3a6f511181b" \
    --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/a8b75242-c3f4-3ab4-ba1a-f3a6f511181b';
$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/a8b75242-c3f4-3ab4-ba1a-f3a6f511181b"
);

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: a8b75242-c3f4-3ab4-ba1a-f3a6f511181b

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\": \"placeat\",
    \"description\": \"Non sed soluta itaque deleniti tempore et earum.\",
    \"company_location_uuid\": \"9b862225-5104-3ca7-823c-e5ff3ddfc2c1\",
    \"customer_uuid\": \"0e620b7f-c0f0-3a5c-9881-13a0f3a5d65b\",
    \"customer_address_uuid\": \"97456452-197b-3f2a-8bbe-d3bf70ac6d65\",
    \"status_uuid\": \"36e370cb-8930-31f9-9900-53786753d11b\",
    \"service_plan_uuids\": [
        \"sit\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"8a6fdf5c-3388-3688-bffb-6042aa325bca\",
    \"expire_at\": \"2025-09-24T05:02:00\"
}"
$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' => 'placeat',
            'description' => 'Non sed soluta itaque deleniti tempore et earum.',
            'company_location_uuid' => '9b862225-5104-3ca7-823c-e5ff3ddfc2c1',
            'customer_uuid' => '0e620b7f-c0f0-3a5c-9881-13a0f3a5d65b',
            'customer_address_uuid' => '97456452-197b-3f2a-8bbe-d3bf70ac6d65',
            'status_uuid' => '36e370cb-8930-31f9-9900-53786753d11b',
            'service_plan_uuids' => [
                'sit',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => '8a6fdf5c-3388-3688-bffb-6042aa325bca',
            'expire_at' => '2025-09-24T05:02:00',
        ],
    ]
);
$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": "placeat",
    "description": "Non sed soluta itaque deleniti tempore et earum.",
    "company_location_uuid": "9b862225-5104-3ca7-823c-e5ff3ddfc2c1",
    "customer_uuid": "0e620b7f-c0f0-3a5c-9881-13a0f3a5d65b",
    "customer_address_uuid": "97456452-197b-3f2a-8bbe-d3bf70ac6d65",
    "status_uuid": "36e370cb-8930-31f9-9900-53786753d11b",
    "service_plan_uuids": [
        "sit"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "8a6fdf5c-3388-3688-bffb-6042aa325bca",
    "expire_at": "2025-09-24T05:02:00"
};

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: placeat

description   string  optional  

The paragraph describing the proposal. Example: Non sed soluta itaque deleniti tempore et earum.

company_location_uuid   string  optional  

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 9b862225-5104-3ca7-823c-e5ff3ddfc2c1

customer_uuid   string  optional  

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0e620b7f-c0f0-3a5c-9881-13a0f3a5d65b

customer_address_uuid   string  optional  

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 97456452-197b-3f2a-8bbe-d3bf70ac6d65

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 36e370cb-8930-31f9-9900-53786753d11b

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: 8a6fdf5c-3388-3688-bffb-6042aa325bca

include_fields   object  optional  
expire_at   string  optional  

Must be a valid date. Example: 2025-09-24T05:02:00

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:\\/\\/runte.com\\/\",
    \"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://runte.com/',
            '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:\/\/runte.com\/",
    "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://runte.com/

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/997115f5-0071-3dad-a8d1-0245d17b7cb3" \
    --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/997115f5-0071-3dad-a8d1-0245d17b7cb3';
$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/997115f5-0071-3dad-a8d1-0245d17b7cb3"
);

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: 997115f5-0071-3dad-a8d1-0245d17b7cb3

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: 13

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : title Example: molestiae

sort_order   string  optional  

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

search   string  optional  

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

filter_by_uuids   string  optional  

string[] To fitler by selected uuids. Example : [uuid, uuid-2] Example: dolorem

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\": \"accusamus\",
    \"content\": \"consequatur\"
}"
$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' => 'accusamus',
            'content' => 'consequatur',
        ],
    ]
);
$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": "accusamus",
    "content": "consequatur"
};

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: accusamus

content   string   

The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: consequatur

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\": \"ipsam\",
    \"content\": \"magnam\"
}"
$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' => 'ipsam',
            'content' => 'magnam',
        ],
    ]
);
$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": "ipsam",
    "content": "magnam"
};

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: ipsam

content   string   

The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: magnam

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\": \"natus\",
    \"content\": \"placeat\"
}"
$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' => 'natus',
            'content' => 'placeat',
        ],
    ]
);
$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": "natus",
    "content": "placeat"
};

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: natus

content   string  optional  

optional The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: placeat

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\": \"est\",
    \"content\": \"qui\"
}"
$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' => 'est',
            'content' => 'qui',
        ],
    ]
);
$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": "est",
    "content": "qui"
};

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: est

content   string  optional  

optional The content of the service agreement. Example : Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor Example: qui

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/doloribus" \
    --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/doloribus';
$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/doloribus"
);

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: doloribus

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/phpMRP3OM" 
$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/phpMRP3OM', '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/phpMRP3OM

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:\\/\\/www.bartell.info\\/\",
    \"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://www.bartell.info/',
            '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:\/\/www.bartell.info\/",
    "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://www.bartell.info/

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:\\/\\/marks.com\\/minus-modi-ut-quo-quam\",
    \"google_my_business_listing\": \"http:\\/\\/www.runte.biz\\/ipsum-laudantium-natus-excepturi-esse-qui\",
    \"image_url\": \"http:\\/\\/connelly.com\\/non-nihil-inventore-quis-consequatur\",
    \"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://marks.com/minus-modi-ut-quo-quam',
            'google_my_business_listing' => 'http://www.runte.biz/ipsum-laudantium-natus-excepturi-esse-qui',
            'image_url' => 'http://connelly.com/non-nihil-inventore-quis-consequatur',
            '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:\/\/marks.com\/minus-modi-ut-quo-quam",
    "google_my_business_listing": "http:\/\/www.runte.biz\/ipsum-laudantium-natus-excepturi-esse-qui",
    "image_url": "http:\/\/connelly.com\/non-nihil-inventore-quis-consequatur",
    "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://marks.com/minus-modi-ut-quo-quam

google_my_business_listing   string  optional  

Must be a valid URL. Example: http://www.runte.biz/ipsum-laudantium-natus-excepturi-esse-qui

image_url   string  optional  

Example: http://connelly.com/non-nihil-inventore-quis-consequatur

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\": \"delectus\"
}"
$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' => 'delectus',
        ],
    ]
);
$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": "delectus"
};

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: delectus

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\": \"corporis\",
    \"address2\": \"nulla\",
    \"city\": \"dolor\",
    \"country_state_uuid\": \"e969d074-177c-3535-aa23-ae6ae4b27727\",
    \"country_uuid\": \"ac018c1c-41db-31cf-a9cb-257ad9be9fd7\",
    \"postal_code\": \"dolores\",
    \"latitude\": \"nobis\",
    \"longitude\": \"occaecati\",
    \"is_primary\": \"ut\",
    \"settings\": \"modi\",
    \"county\": \"impedit\"
}"
$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' => 'corporis',
            'address2' => 'nulla',
            'city' => 'dolor',
            'country_state_uuid' => 'e969d074-177c-3535-aa23-ae6ae4b27727',
            'country_uuid' => 'ac018c1c-41db-31cf-a9cb-257ad9be9fd7',
            'postal_code' => 'dolores',
            'latitude' => 'nobis',
            'longitude' => 'occaecati',
            'is_primary' => 'ut',
            'settings' => 'modi',
            'county' => 'impedit',
        ],
    ]
);
$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": "corporis",
    "address2": "nulla",
    "city": "dolor",
    "country_state_uuid": "e969d074-177c-3535-aa23-ae6ae4b27727",
    "country_uuid": "ac018c1c-41db-31cf-a9cb-257ad9be9fd7",
    "postal_code": "dolores",
    "latitude": "nobis",
    "longitude": "occaecati",
    "is_primary": "ut",
    "settings": "modi",
    "county": "impedit"
};

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: corporis

address2   string  optional  

optional The address 2. Example : Address 2 Example: nulla

city   string  optional  

optional The city. Example : Queen Creek Example: dolor

country_state_uuid   string  optional  

optional The state uuid. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: e969d074-177c-3535-aa23-ae6ae4b27727

country_uuid   string  optional  

optional The country uuid. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: ac018c1c-41db-31cf-a9cb-257ad9be9fd7

postal_code   string  optional  

optional The postal code. Example : 12345 Example: dolores

latitude   string  optional  

optional The latitude. Example : 33.2486 Example: nobis

longitude   string  optional  

optional The longitude. Example : 111.6377 Example: occaecati

is_primary   string  optional  

optional The is_primary. Example : true Example: ut

settings   string  optional  

optional The settings. Example : {} Example: modi

county   string  optional  

optional The county. Example : Pinal County Example: impedit

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: 3

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: voluptate

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: sit

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/bfc63f57-34ee-3dcf-bc6b-836aed9b5d46" \
    --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/bfc63f57-34ee-3dcf-bc6b-836aed9b5d46';
$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/bfc63f57-34ee-3dcf-bc6b-836aed9b5d46"
);

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: bfc63f57-34ee-3dcf-bc6b-836aed9b5d46

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/fbd09e5d-c1b0-3b2b-b9a4-93de6925abfa" \
    --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/fbd09e5d-c1b0-3b2b-b9a4-93de6925abfa';
$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/fbd09e5d-c1b0-3b2b-b9a4-93de6925abfa"
);

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/{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: fbd09e5d-c1b0-3b2b-b9a4-93de6925abfa

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.

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/f1a7afb3-d1db-39bf-b1b4-fc995e4e8fd6" \
    --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/f1a7afb3-d1db-39bf-b1b4-fc995e4e8fd6';
$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/f1a7afb3-d1db-39bf-b1b4-fc995e4e8fd6"
);

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: f1a7afb3-d1db-39bf-b1b4-fc995e4e8fd6

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/b424ec0d-1799-3dfe-9e09-fdd9600b5bd9" \
    --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/b424ec0d-1799-3dfe-9e09-fdd9600b5bd9';
$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/b424ec0d-1799-3dfe-9e09-fdd9600b5bd9"
);

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: b424ec0d-1799-3dfe-9e09-fdd9600b5bd9

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: 20

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : title Example: tempora

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: excepturi

filter_by_uuids   string  optional  

string[] To filter by selected uuids. Example : [uuid, uuid-2] Example: enim

groups   string  optional  

string[] To filter by selected groups. Example : [dashboard, sales] Example: voluptatem

report_type   string  optional  

To filter by selected report type. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: vitae

template   string  optional  

To filter by selected template. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: voluptatibus

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: 72b60382-388f-30d0-8d30-ab85eacd9515

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: asperiores

company_location_uuid   string  optional  

optional string The company location uuid. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 91773bca-b60e-3619-bfae-9c798588dfc2

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\": [
        \"fugit\"
    ],
    \"import_files\": \"ut\",
    \"override\": false,
    \"admin_only\": true
}"
$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' => [
                'fugit',
            ],
            'import_files' => 'ut',
            '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"
);

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

let body = {
    "tags": [
        "fugit"
    ],
    "import_files": "ut",
    "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

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: ut

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

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\": [
        \"dolor\"
    ],
    \"import_files\": \"eum\",
    \"override\": true,
    \"admin_only\": false
}"
$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' => [
                'dolor',
            ],
            'import_files' => 'eum',
            'override' => true,
            '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/upload"
);

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

let body = {
    "tags": [
        "dolor"
    ],
    "import_files": "eum",
    "override": true,
    "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/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: eum

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: false

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: 20

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: sed

sort_order   string  optional  

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

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: voluptatem

type_code   string  optional  

Filter by import type name : "categories" Example: repudiandae

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\": [
        \"officiis\"
    ],
    \"import_files\": \"fugit\",
    \"override\": false,
    \"admin_only\": false
}"
$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' => [
                'officiis',
            ],
            'import_files' => 'fugit',
            'override' => false,
            'admin_only' => false,
        ],
    ]
);
$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": [
        "officiis"
    ],
    "import_files": "fugit",
    "override": false,
    "admin_only": false
};

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: fugit

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

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\": \"ab\",
    \"admin_only\": false,
    \"is_selected\": false
}"
$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' => 'ab',
            'admin_only' => false,
            'is_selected' => false,
        ],
    ]
);
$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": "ab",
    "admin_only": false,
    "is_selected": false
};

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: ab

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: false

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\": true,
    \"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' => true,
            '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": true,
    "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: true

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: 5

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: autem

sort_order   string  optional  

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

search   string  optional  

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

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\": [
        \"voluptatum\"
    ],
    \"import_files\": \"in\",
    \"override\": true,
    \"admin_only\": false
}"
$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' => [
                'voluptatum',
            ],
            'import_files' => 'in',
            'override' => true,
            'admin_only' => false,
        ],
    ]
);
$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": [
        "voluptatum"
    ],
    "import_files": "in",
    "override": true,
    "admin_only": false
};

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: in

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: false

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: 17

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: aliquam

search   string  optional  

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

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\": \"aliquam\",
    \"assignment\": \"laborum\",
    \"form_fields\": [
        \"quibusdam\"
    ]
}"
$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' => 'aliquam',
            'assignment' => 'laborum',
            'form_fields' => [
                'quibusdam',
            ],
        ],
    ]
);
$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": "aliquam",
    "assignment": "laborum",
    "form_fields": [
        "quibusdam"
    ]
};

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: aliquam

assignment   string   

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: laborum

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: atque

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: nulla

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: sint

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 help guide of the form fiel. Example : "This field is to select Yes or No" Example: sint

position   integer  optional  

A position of the form fiel. Example : 1 Example: 8

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\": \"et\",
    \"assignment\": \"eos\",
    \"form_fields\": [
        \"sed\"
    ]
}"
$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' => 'et',
            'assignment' => 'eos',
            'form_fields' => [
                'sed',
            ],
        ],
    ]
);
$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": "et",
    "assignment": "eos",
    "form_fields": [
        "sed"
    ]
};

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: et

assignment   string   

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: eos

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: ut

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: facilis

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: velit

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: 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: nisi

position   integer  optional  

A position of the form fiel. Example : 1 Example: 3

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\": \"quisquam\",
    \"assignment\": \"labore\",
    \"form_fields\": [
        \"commodi\"
    ]
}"
$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' => 'quisquam',
            'assignment' => 'labore',
            'form_fields' => [
                'commodi',
            ],
        ],
    ]
);
$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": "quisquam",
    "assignment": "labore",
    "form_fields": [
        "commodi"
    ]
};

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: quisquam

assignment   string   

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: labore

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: vitae

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: quo

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: quia

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 helkp guide of the form fiel. Example : "This field is to select Yes or No" Example: id

position   integer  optional  

A position of the form fiel. Example : 1 Example: 1

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\": \"veniam\",
    \"assignment\": \"officia\",
    \"form_fields\": [
        \"minus\"
    ]
}"
$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' => 'veniam',
            'assignment' => 'officia',
            'form_fields' => [
                'minus',
            ],
        ],
    ]
);
$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": "veniam",
    "assignment": "officia",
    "form_fields": [
        "minus"
    ]
};

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: veniam

assignment   string  optional  

The terms of the form ("QUALITY_ASSURANCE", "SERVICE_PLANS", "PROPOSAL_TEMPLATES"). Example : "QUALITY_ASSURANCE" Example: officia

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: assumenda

input_type   string  optional  

The input_type of a form field ('TEXT,NUMBER,TEXT_EDITOR,SELECT,MULTI_SELECT,CHECKBOX,DATE'). Example : "MULTI_SELECT" Example: quae

default_value   string  optional  

The default value of the form field. Example : "Yes\n No" Example: nostrum

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: false

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 helkp guide of the form fiel. Example : "This field is to select Yes or No" Example: accusantium

position   integer  optional  

A position of the form fiel. Example : 1 Example: 1

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: 9

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: cupiditate

sort_order   string  optional  

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

search   string  optional  

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

exclude   string  optional  

array An array of UUID to exclude from the results. Example : ['3245d630-24fd-11ec-accd-e397aec85c7f'] Example: aut

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\": \"vel\",
    \"options\": [
        \"eveniet\"
    ]
}"
$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' => 'vel',
            'options' => [
                'eveniet',
            ],
        ],
    ]
);
$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": "vel",
    "options": [
        "eveniet"
    ]
};

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: vel

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\": \"consectetur\",
    \"options\": [
        \"quia\"
    ]
}"
$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' => 'consectetur',
            'options' => [
                'quia',
            ],
        ],
    ]
);
$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": "consectetur",
    "options": [
        "quia"
    ]
};

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: consectetur

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\": \"consequatur\",
    \"options\": [
        \"esse\"
    ]
}"
$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' => 'consequatur',
            'options' => [
                'esse',
            ],
        ],
    ]
);
$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": "consequatur",
    "options": [
        "esse"
    ]
};

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: consequatur

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: 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 : name Example: rem

sort_order   string  optional  

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

search   string  optional  

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

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\": \"perferendis\",
    \"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' => 'perferendis',
            '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": "perferendis",
    "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: perferendis

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\": \"fuga\",
    \"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' => 'fuga',
            '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": "fuga",
    "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: fuga

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\": \"repellat\",
    \"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' => 'repellat',
            '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": "repellat",
    "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: repellat

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: 7

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: dolore

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: 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: quam

filter_by_status_uuid   string  optional  

To filter the list the status. Example : "3c787d66-2a4f-3f1d-9591-c330be0abe82" Example: e91f9bf1-3e48-3825-a946-2eb19ad68510

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\": \"45f394cf-e880-39dc-9d51-86ecd341f720\",
    \"name\": \"commodi\",
    \"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' => '45f394cf-e880-39dc-9d51-86ecd341f720',
            'name' => 'commodi',
            '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": "45f394cf-e880-39dc-9d51-86ecd341f720",
    "name": "commodi",
    "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: 45f394cf-e880-39dc-9d51-86ecd341f720

name   string   

The name of the solution. Example : Solution 1 Example: commodi

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/phpC5nc7L" 
$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/phpC5nc7L', '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/phpC5nc7L

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\": \"c436075d-d2cb-3ad8-9fbe-3c827f13e23b\",
    \"name\": \"molestiae\",
    \"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' => 'c436075d-d2cb-3ad8-9fbe-3c827f13e23b',
            'name' => 'molestiae',
            '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": "c436075d-d2cb-3ad8-9fbe-3c827f13e23b",
    "name": "molestiae",
    "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: c436075d-d2cb-3ad8-9fbe-3c827f13e23b

name   string   

The name of the solution. Example : Solution 1 Example: molestiae

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\": false,
    \"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' => false,
            '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": false,
    "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: false

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: quia

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\": \"38e1c59e-8432-3ba7-84b1-c928f37d0b89\",
    \"name\": \"earum\",
    \"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' => '38e1c59e-8432-3ba7-84b1-c928f37d0b89',
            'name' => 'earum',
            '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": "38e1c59e-8432-3ba7-84b1-c928f37d0b89",
    "name": "earum",
    "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: 38e1c59e-8432-3ba7-84b1-c928f37d0b89

name   string  optional  

The name of the solution. Example : Solution 1 Example: earum

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\": [
        \"consequuntur\"
    ],
    \"customer_address\": [
        \"alias\"
    ]
}"
$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' => [
                'consequuntur',
            ],
            'customer_address' => [
                'alias',
            ],
        ],
    ]
);
$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": [
        "consequuntur"
    ],
    "customer_address": [
        "alias"
    ]
};

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\": [
        \"officia\"
    ],
    \"customer_address\": [
        \"consequatur\"
    ]
}"
$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' => [
                'officia',
            ],
            'customer_address' => [
                'consequatur',
            ],
        ],
    ]
);
$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": [
        "officia"
    ],
    "customer_address": [
        "consequatur"
    ]
};

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: 1

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: dolorum

sort_order   string  optional  

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

search   string  optional  

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

category_group   string  optional  

The category group to filter by. Example : SERVICE_PLAN Example: est

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\": \"SERVICE_PLAN\"
}"
$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' => '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: "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: SERVICE_PLAN

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: 3

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: sed

sort_order   string  optional  

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

search   string  optional  

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

type   string  optional  

in:'service','billing' The filter by type. Example : service Example: non

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\": \"deleniti\",
    \"description\": \"Laboriosam asperiores eveniet necessitatibus distinctio temporibus similique ut.\",
    \"type\": \"sint\",
    \"units\": 15,
    \"term\": \"quidem\",
    \"enabled_service_months\": [
        \"modi\"
    ],
    \"visits\": 13
}"
$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' => 'deleniti',
            'description' => 'Laboriosam asperiores eveniet necessitatibus distinctio temporibus similique ut.',
            'type' => 'sint',
            'units' => 15,
            'term' => 'quidem',
            'enabled_service_months' => [
                'modi',
            ],
            'visits' => 13,
        ],
    ]
);
$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": "deleniti",
    "description": "Laboriosam asperiores eveniet necessitatibus distinctio temporibus similique ut.",
    "type": "sint",
    "units": 15,
    "term": "quidem",
    "enabled_service_months": [
        "modi"
    ],
    "visits": 13
};

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: deleniti

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Laboriosam asperiores eveniet necessitatibus distinctio temporibus similique ut.

type   string   

The type of the schedule (service, billing). Example : "service" Example: sint

units   integer   

The number of week(s)/month(s)/year(s) of a schedule. Example : 5 Example: 15

term   string   

The terms of the schedule (week/month/year). Example : week Example: quidem

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: 13

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\": \"necessitatibus\",
    \"description\": \"Doloribus quia repellendus quam aut voluptatem consequatur.\",
    \"type\": \"pariatur\",
    \"units\": 19,
    \"term\": \"et\",
    \"enabled_service_months\": [
        \"tempore\"
    ],
    \"visits\": 9
}"
$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' => 'necessitatibus',
            'description' => 'Doloribus quia repellendus quam aut voluptatem consequatur.',
            'type' => 'pariatur',
            'units' => 19,
            'term' => 'et',
            'enabled_service_months' => [
                'tempore',
            ],
            'visits' => 9,
        ],
    ]
);
$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": "necessitatibus",
    "description": "Doloribus quia repellendus quam aut voluptatem consequatur.",
    "type": "pariatur",
    "units": 19,
    "term": "et",
    "enabled_service_months": [
        "tempore"
    ],
    "visits": 9
};

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: necessitatibus

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Doloribus quia repellendus quam aut voluptatem consequatur.

type   string   

The type of the schedule (service, billing). Example : "service" Example: pariatur

units   integer   

The number of week(s)/month(s)/year(s) of a schedule. Example : 5 Example: 19

term   string   

The terms of the schedule (week/month/year). Example : week Example: et

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: 9

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\": \"inventore\",
    \"description\": \"Accusantium consequatur et saepe suscipit qui et occaecati.\",
    \"type\": \"architecto\",
    \"units\": 2,
    \"term\": \"laudantium\",
    \"enabled_service_months\": [
        \"consectetur\"
    ],
    \"visits\": 3
}"
$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' => 'inventore',
            'description' => 'Accusantium consequatur et saepe suscipit qui et occaecati.',
            'type' => 'architecto',
            'units' => 2,
            'term' => 'laudantium',
            'enabled_service_months' => [
                'consectetur',
            ],
            'visits' => 3,
        ],
    ]
);
$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": "inventore",
    "description": "Accusantium consequatur et saepe suscipit qui et occaecati.",
    "type": "architecto",
    "units": 2,
    "term": "laudantium",
    "enabled_service_months": [
        "consectetur"
    ],
    "visits": 3
};

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: inventore

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Accusantium consequatur et saepe suscipit qui et occaecati.

type   string   

The type of the schedule (service, billing). Example : "service" Example: architecto

units   integer   

The number of week(s)/month(s)/year(s) of a schedule. Example : 5 Example: 2

term   string   

The terms of the schedule (week/month/year). Example : week Example: laudantium

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: 3

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