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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": 413.31
}"

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

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

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

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

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\": \"quas\",
    \"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\": 2866.691,
    \"save_as\": \"SERVICE_PLAN_ARCHIVED\"
}"

$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' => 'quas',
            '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' => 2866.691,
            'save_as' => 'SERVICE_PLAN_ARCHIVED',
        ],
    ]
);
$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": "quas",
    "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": 2866.691,
    "save_as": "SERVICE_PLAN_ARCHIVED"
};

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

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

save_as   string  optional  

Example: SERVICE_PLAN_ARCHIVED

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: odio

sort_order   string  optional  

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

search   string  optional  

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

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

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

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

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

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

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

is_enabled   string  optional  

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

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\": [
        \"quos\"
    ],
    \"filters\": [
        \"et\"
    ],
    \"triggers\": [
        \"laudantium\"
    ]
}"

$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' => [
                'quos',
            ],
            'filters' => [
                'et',
            ],
            'triggers' => [
                'laudantium',
            ],
        ],
    ]
);
$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": [
        "quos"
    ],
    "filters": [
        "et"
    ],
    "triggers": [
        "laudantium"
    ]
};

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\": [
        \"et\"
    ],
    \"filters\": [
        \"vero\"
    ],
    \"triggers\": [
        \"impedit\"
    ]
}"

$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' => [
                'et',
            ],
            'filters' => [
                'vero',
            ],
            'triggers' => [
                'impedit',
            ],
        ],
    ]
);
$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": [
        "et"
    ],
    "filters": [
        "vero"
    ],
    "triggers": [
        "impedit"
    ]
};

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\": [
        \"sit\"
    ],
    \"filters\": [
        \"eos\"
    ],
    \"triggers\": [
        \"perspiciatis\"
    ]
}"

$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' => [
                'sit',
            ],
            'filters' => [
                'eos',
            ],
            'triggers' => [
                'perspiciatis',
            ],
        ],
    ]
);
$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": [
        "sit"
    ],
    "filters": [
        "eos"
    ],
    "triggers": [
        "perspiciatis"
    ]
};

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

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

sort_order   string  optional  

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

search   string  optional  

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

is_all_location   string  optional  

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

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=quas"\
    --form "message=qui"\
    --form "rate=ut"\
    --form "external_photo_url=http://wilderman.biz/quis-rerum-consequuntur-omnis-voluptates-natus.html"\
    --form "position=11"\
    --form "company_location_uuid=f00e795d-21e0-3f88-b9d5-8199babfe4ed"\
    --form "photo=@/tmp/php6yIbwU" 
$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' => 'quas'
            ],
            [
                'name' => 'message',
                'contents' => 'qui'
            ],
            [
                'name' => 'rate',
                'contents' => 'ut'
            ],
            [
                'name' => 'external_photo_url',
                'contents' => 'http://wilderman.biz/quis-rerum-consequuntur-omnis-voluptates-natus.html'
            ],
            [
                'name' => 'position',
                'contents' => '11'
            ],
            [
                'name' => 'company_location_uuid',
                'contents' => 'f00e795d-21e0-3f88-b9d5-8199babfe4ed'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/php6yIbwU', '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', 'quas');
body.append('message', 'qui');
body.append('rate', 'ut');
body.append('external_photo_url', 'http://wilderman.biz/quis-rerum-consequuntur-omnis-voluptates-natus.html');
body.append('position', '11');
body.append('company_location_uuid', 'f00e795d-21e0-3f88-b9d5-8199babfe4ed');
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: quas

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

photo   file  optional  

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

external_photo_url   string  optional  

An external url of an image as review/photo. Example: http://wilderman.biz/quis-rerum-consequuntur-omnis-voluptates-natus.html

position   integer  optional  

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

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: f00e795d-21e0-3f88-b9d5-8199babfe4ed

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=sit"\
    --form "message=sint"\
    --form "rate=accusamus"\
    --form "external_photo_url=http://www.keeling.com/"\
    --form "position=9"\
    --form "company_location_uuid=67f4a83d-335f-372e-accb-1fa2ab5a9de6"\
    --form "photo=@/tmp/phpAIR8QU" 
$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' => 'sit'
            ],
            [
                'name' => 'message',
                'contents' => 'sint'
            ],
            [
                'name' => 'rate',
                'contents' => 'accusamus'
            ],
            [
                'name' => 'external_photo_url',
                'contents' => 'http://www.keeling.com/'
            ],
            [
                'name' => 'position',
                'contents' => '9'
            ],
            [
                'name' => 'company_location_uuid',
                'contents' => '67f4a83d-335f-372e-accb-1fa2ab5a9de6'
            ],
            [
                'name' => 'photo',
                'contents' => fopen('/tmp/phpAIR8QU', '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', 'sit');
body.append('message', 'sint');
body.append('rate', 'accusamus');
body.append('external_photo_url', 'http://www.keeling.com/');
body.append('position', '9');
body.append('company_location_uuid', '67f4a83d-335f-372e-accb-1fa2ab5a9de6');
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: sit

message   string  optional  

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

rate   string   

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

photo   file  optional  

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

external_photo_url   string  optional  

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

position   integer  optional  

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

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: 67f4a83d-335f-372e-accb-1fa2ab5a9de6

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

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\": \"deserunt\",
    \"message\": \"accusantium\",
    \"rate\": \"modi\",
    \"external_photo_url\": \"http:\\/\\/www.bergstrom.com\\/commodi-fuga-libero-vel-qui-sed.html\",
    \"position\": 7,
    \"company_location_uuid\": \"7789ee3f-243d-3004-9375-5201174c3ac9\"
}"

$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' => 'deserunt',
            'message' => 'accusantium',
            'rate' => 'modi',
            'external_photo_url' => 'http://www.bergstrom.com/commodi-fuga-libero-vel-qui-sed.html',
            'position' => 7,
            'company_location_uuid' => '7789ee3f-243d-3004-9375-5201174c3ac9',
        ],
    ]
);
$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": "deserunt",
    "message": "accusantium",
    "rate": "modi",
    "external_photo_url": "http:\/\/www.bergstrom.com\/commodi-fuga-libero-vel-qui-sed.html",
    "position": 7,
    "company_location_uuid": "7789ee3f-243d-3004-9375-5201174c3ac9"
};

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

message   string  optional  

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

rate   string  optional  

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

external_photo_url   string  optional  

An external url of an image as review/photo. Example: http://www.bergstrom.com/commodi-fuga-libero-vel-qui-sed.html

position   integer  optional  

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

company_location_uuid   uuid  optional  

The company location to be associated to the review. Leaving empty/blank means visible to all company locations. Example: 7789ee3f-243d-3004-9375-5201174c3ac9

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

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

sort_order   string  optional  

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

search   string  optional  

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

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/e23e6850-2cd1-3a1b-93d6-42acd267c232" \
    --header "Authorization: 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/e23e6850-2cd1-3a1b-93d6-42acd267c232';
$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/e23e6850-2cd1-3a1b-93d6-42acd267c232"
);

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: e23e6850-2cd1-3a1b-93d6-42acd267c232

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\": \"minus\",
    \"input_type\": \"minus\",
    \"default_value\": \"ducimus\",
    \"is_required\": false,
    \"is_conditional\": false,
    \"has_help_guide\": false,
    \"conditional_value\": \"quaerat\",
    \"help_guide\": \"culpa\",
    \"position\": 2
}"

$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' => 'minus',
            'input_type' => 'minus',
            'default_value' => 'ducimus',
            'is_required' => false,
            'is_conditional' => false,
            'has_help_guide' => false,
            'conditional_value' => 'quaerat',
            'help_guide' => 'culpa',
            'position' => 2,
        ],
    ]
);
$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": "minus",
    "input_type": "minus",
    "default_value": "ducimus",
    "is_required": false,
    "is_conditional": false,
    "has_help_guide": false,
    "conditional_value": "quaerat",
    "help_guide": "culpa",
    "position": 2
};

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

input_type   string   

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

default_value   string  optional  

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

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

help_guide   string  optional  

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

position   integer  optional  

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

Update

requires authentication

Update a formfield.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/1070f0ed-1c6b-33b3-875b-fc31868a0991" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"et\",
    \"input_type\": \"rerum\",
    \"default_value\": \"aut\",
    \"is_required\": false,
    \"is_conditional\": true,
    \"has_help_guide\": false,
    \"conditional_value\": \"ipsum\",
    \"help_guide\": \"quia\",
    \"position\": 4
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/1070f0ed-1c6b-33b3-875b-fc31868a0991';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'et',
            'input_type' => 'rerum',
            'default_value' => 'aut',
            'is_required' => false,
            'is_conditional' => true,
            'has_help_guide' => false,
            'conditional_value' => 'ipsum',
            'help_guide' => 'quia',
            'position' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/1070f0ed-1c6b-33b3-875b-fc31868a0991"
);

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

let body = {
    "label": "et",
    "input_type": "rerum",
    "default_value": "aut",
    "is_required": false,
    "is_conditional": true,
    "has_help_guide": false,
    "conditional_value": "ipsum",
    "help_guide": "quia",
    "position": 4
};

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: 1070f0ed-1c6b-33b3-875b-fc31868a0991

Body Parameters

label   string   

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

input_type   string   

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

default_value   string  optional  

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

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

help_guide   string  optional  

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

position   integer  optional  

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

Update

requires authentication

Update a formfield.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/a9de2c0b-b3a5-3f81-8370-7c7cf2c2f968" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"officiis\",
    \"input_type\": \"veritatis\",
    \"default_value\": \"delectus\",
    \"is_required\": true,
    \"is_conditional\": false,
    \"has_help_guide\": true,
    \"conditional_value\": \"recusandae\",
    \"help_guide\": \"eum\",
    \"position\": 4
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/a9de2c0b-b3a5-3f81-8370-7c7cf2c2f968';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'officiis',
            'input_type' => 'veritatis',
            'default_value' => 'delectus',
            'is_required' => true,
            'is_conditional' => false,
            'has_help_guide' => true,
            'conditional_value' => 'recusandae',
            'help_guide' => 'eum',
            'position' => 4,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/a9de2c0b-b3a5-3f81-8370-7c7cf2c2f968"
);

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

let body = {
    "label": "officiis",
    "input_type": "veritatis",
    "default_value": "delectus",
    "is_required": true,
    "is_conditional": false,
    "has_help_guide": true,
    "conditional_value": "recusandae",
    "help_guide": "eum",
    "position": 4
};

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: a9de2c0b-b3a5-3f81-8370-7c7cf2c2f968

Body Parameters

label   string   

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

input_type   string   

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

default_value   string  optional  

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

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

help_guide   string  optional  

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

position   integer  optional  

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

Patch

requires authentication

Patch a company form field.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/c184f823-dfe0-3709-9af4-7af4b8e27cb0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"rem\",
    \"input_type\": \"beatae\",
    \"default_value\": \"et\",
    \"is_required\": false,
    \"is_conditional\": false,
    \"has_help_guide\": true,
    \"conditional_value\": \"doloremque\",
    \"help_guide\": \"non\",
    \"position\": 5
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/c184f823-dfe0-3709-9af4-7af4b8e27cb0';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'label' => 'rem',
            'input_type' => 'beatae',
            'default_value' => 'et',
            'is_required' => false,
            'is_conditional' => false,
            'has_help_guide' => true,
            'conditional_value' => 'doloremque',
            'help_guide' => 'non',
            'position' => 5,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/c184f823-dfe0-3709-9af4-7af4b8e27cb0"
);

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

let body = {
    "label": "rem",
    "input_type": "beatae",
    "default_value": "et",
    "is_required": false,
    "is_conditional": false,
    "has_help_guide": true,
    "conditional_value": "doloremque",
    "help_guide": "non",
    "position": 5
};

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: c184f823-dfe0-3709-9af4-7af4b8e27cb0

Body Parameters

label   string  optional  

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

input_type   string  optional  

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

default_value   string  optional  

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

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

conditional_value   text  optional  

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

help_guide   string  optional  

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

position   integer  optional  

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

Delete

requires authentication

Delete a form field.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/forms/2/fields/88c27f8d-52e7-3aab-a34c-a3402eee69be" \
    --header "Authorization: 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/88c27f8d-52e7-3aab-a34c-a3402eee69be';
$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/88c27f8d-52e7-3aab-a34c-a3402eee69be"
);

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: 88c27f8d-52e7-3aab-a34c-a3402eee69be

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"hkmneyotmqdjjqhxmmlwxh\",
    \"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' => 'hkmneyotmqdjjqhxmmlwxh',
            '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": "hkmneyotmqdjjqhxmmlwxh",
    "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: hkmneyotmqdjjqhxmmlwxh
label   string   

Must not be greater than 191 characters. Example: zwo

input_type   string  optional  
combine_input_value_collection   boolean  optional  

Example: false

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/be77c142-fd16-3f11-bc3e-7ec1e807ca49" \
    --header "Authorization: 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/be77c142-fd16-3f11-bc3e-7ec1e807ca49';
$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/be77c142-fd16-3f11-bc3e-7ec1e807ca49"
);

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: be77c142-fd16-3f11-bc3e-7ec1e807ca49

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/1006902e-de61-3db7-a7a7-4e4c29153e36" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"custom_fields\": \"rpeobttqk\",
    \"save_service_plan_as\": \"SERVICE_PLAN_DRAFT\",
    \"label\": \"First Name\",
    \"input_type\": \"TEXT\",
    \"default_value\": \"\\\"\\\"\",
    \"combine_input_value_collection\": true
}"

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

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

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

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

Request      

PUT api/v1/service-plans/{servicePlan_uuid}/custom-fields/{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: 1006902e-de61-3db7-a7a7-4e4c29153e36

Body Parameters

custom_fields   string[]  optional  

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

Must not be greater than 191 characters. Example: bjdoyjwjtax

input_type   string  optional  
combine_input_value_collection   boolean  optional  

Example: false

save_service_plan_as   string  optional  

Example: SERVICE_PLAN_DRAFT

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

The label Service Plan Custom Field. Example: First Name

input_type   string   

The field type of the custom field. Example: TEXT

default_value   string  optional  

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

combine_input_value_collection   boolean  optional  

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

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/0e7e90b6-24d2-395b-941f-a9dccdea73b9" \
    --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/0e7e90b6-24d2-395b-941f-a9dccdea73b9';
$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/0e7e90b6-24d2-395b-941f-a9dccdea73b9"
);

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: 0e7e90b6-24d2-395b-941f-a9dccdea73b9

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/59545fcd-a7b4-36fa-83d1-3415022dc35c" \
    --header "Authorization: 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/59545fcd-a7b4-36fa-83d1-3415022dc35c';
$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/59545fcd-a7b4-36fa-83d1-3415022dc35c"
);

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: 59545fcd-a7b4-36fa-83d1-3415022dc35c

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"expedita\"
}"

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

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

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\": \"non\"
}"

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

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

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\": \"repudiandae\"
}"

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

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"facere\"
}"

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

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

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\": \"nostrum\"
}"

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

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

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\": \"vitae\"
}"

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

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

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/9fa4e283-7778-38ad-88d4-13e2430710f4/states/7716422c-ad78-389c-8ceb-9eaa6931626b" \
    --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/9fa4e283-7778-38ad-88d4-13e2430710f4/states/7716422c-ad78-389c-8ceb-9eaa6931626b';
$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/9fa4e283-7778-38ad-88d4-13e2430710f4/states/7716422c-ad78-389c-8ceb-9eaa6931626b"
);

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: 9fa4e283-7778-38ad-88d4-13e2430710f4

countryStateUuid   string   

Example: 7716422c-ad78-389c-8ceb-9eaa6931626b

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

sort_by   string  optional  

The column name. Example : name Example: ullam

sort_order   string  optional  

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

search   string  optional  

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

country_uuid   string  optional  

The UUID of country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 6ca0021b-c115-3182-aec9-ecd95aa4f49f

country_state_uuids   integer  optional  

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

is_compound   string  optional  

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

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

Show

requires authentication

Show a single tax.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/taxes/bf96f7ba-7e5d-30ce-920b-4067d536ca57" \
    --header "Authorization: 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/bf96f7ba-7e5d-30ce-920b-4067d536ca57';
$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/bf96f7ba-7e5d-30ce-920b-4067d536ca57"
);

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: bf96f7ba-7e5d-30ce-920b-4067d536ca57

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\": \"776bb4c6-f701-39bc-82a1-86ba33164fe5\",
    \"country_state_uuids\": [
        \"omnis\"
    ],
    \"name\": \"minus\",
    \"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' => '776bb4c6-f701-39bc-82a1-86ba33164fe5',
            'country_state_uuids' => [
                'omnis',
            ],
            'name' => 'minus',
            '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": "776bb4c6-f701-39bc-82a1-86ba33164fe5",
    "country_state_uuids": [
        "omnis"
    ],
    "name": "minus",
    "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: 776bb4c6-f701-39bc-82a1-86ba33164fe5

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

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/48dbb7d5-1ad5-361a-b65a-1718fe6b00b0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"39465ad7-182c-350f-8606-034168746dfe\",
    \"country_state_uuids\": [
        \"rerum\"
    ],
    \"name\": \"est\",
    \"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/48dbb7d5-1ad5-361a-b65a-1718fe6b00b0';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => '39465ad7-182c-350f-8606-034168746dfe',
            'country_state_uuids' => [
                'rerum',
            ],
            'name' => 'est',
            '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/48dbb7d5-1ad5-361a-b65a-1718fe6b00b0"
);

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

let body = {
    "country_uuid": "39465ad7-182c-350f-8606-034168746dfe",
    "country_state_uuids": [
        "rerum"
    ],
    "name": "est",
    "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: 48dbb7d5-1ad5-361a-b65a-1718fe6b00b0

Body Parameters

country_uuid   string   

The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 39465ad7-182c-350f-8606-034168746dfe

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

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/a40e5d3c-d425-3f39-9c13-f3a419ba18ad" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"country_uuid\": \"de003dc6-2fa9-3be4-94e9-a06c6de674cc\",
    \"country_state_uuids\": [
        \"qui\"
    ],
    \"name\": \"non\",
    \"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/a40e5d3c-d425-3f39-9c13-f3a419ba18ad';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'country_uuid' => 'de003dc6-2fa9-3be4-94e9-a06c6de674cc',
            'country_state_uuids' => [
                'qui',
            ],
            'name' => 'non',
            '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/a40e5d3c-d425-3f39-9c13-f3a419ba18ad"
);

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

let body = {
    "country_uuid": "de003dc6-2fa9-3be4-94e9-a06c6de674cc",
    "country_state_uuids": [
        "qui"
    ],
    "name": "non",
    "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: a40e5d3c-d425-3f39-9c13-f3a419ba18ad

Body Parameters

country_uuid   string  optional  

optional The UUID of a country. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: de003dc6-2fa9-3be4-94e9-a06c6de674cc

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

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/fd1018e3-84d1-31ed-b400-e1a0c7ea801f" \
    --header "Authorization: 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/fd1018e3-84d1-31ed-b400-e1a0c7ea801f';
$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/fd1018e3-84d1-31ed-b400-e1a0c7ea801f"
);

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: fd1018e3-84d1-31ed-b400-e1a0c7ea801f

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

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

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

has_service_plans   string  optional  

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

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/2d51cffe-04a1-3393-82f4-81ffa856ef25" \
    --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/2d51cffe-04a1-3393-82f4-81ffa856ef25';
$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/2d51cffe-04a1-3393-82f4-81ffa856ef25"
);

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: 2d51cffe-04a1-3393-82f4-81ffa856ef25

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/459b5b07-e1ac-32c2-a220-198aa12fdf49" \
    --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/459b5b07-e1ac-32c2-a220-198aa12fdf49';
$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/459b5b07-e1ac-32c2-a220-198aa12fdf49"
);

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: 459b5b07-e1ac-32c2-a220-198aa12fdf49

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/5df71178-6da7-3c48-8284-3100b66f81e0" \
    --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/5df71178-6da7-3c48-8284-3100b66f81e0';
$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/5df71178-6da7-3c48-8284-3100b66f81e0"
);

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: 5df71178-6da7-3c48-8284-3100b66f81e0

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/e3912ac8-7f2c-3ad5-907f-1d16de775c66" \
    --header "Authorization: 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/e3912ac8-7f2c-3ad5-907f-1d16de775c66';
$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/e3912ac8-7f2c-3ad5-907f-1d16de775c66"
);

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: e3912ac8-7f2c-3ad5-907f-1d16de775c66

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/86127d93-6722-3f90-bd6b-adb77abd3579/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/86127d93-6722-3f90-bd6b-adb77abd3579/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/86127d93-6722-3f90-bd6b-adb77abd3579/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: 86127d93-6722-3f90-bd6b-adb77abd3579

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\": \"quasi\"
}"

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

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

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/fdfc6fac-8f5e-38c1-91bb-23adb4b0323b/eos" \
    --header "Authorization: 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/fdfc6fac-8f5e-38c1-91bb-23adb4b0323b/eos';
$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/fdfc6fac-8f5e-38c1-91bb-23adb4b0323b/eos"
);

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: fdfc6fac-8f5e-38c1-91bb-23adb4b0323b

action   string   

Example: eos

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/quo" \
    --header "Authorization: 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/quo';
$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/quo"
);

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

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/854101e9-e0a7-3dec-9775-e152c9f613e0" \
    --header "Authorization: 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/854101e9-e0a7-3dec-9775-e152c9f613e0';
$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/854101e9-e0a7-3dec-9775-e152c9f613e0"
);

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: 854101e9-e0a7-3dec-9775-e152c9f613e0

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/a2ae559d-cd43-3807-a130-1843c74c4ab3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"credentials\": [
        \"nesciunt\"
    ],
    \"status_uuid\": \"f2cc735b-3b89-3153-b6f4-54ed092b6a76\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/a2ae559d-cd43-3807-a130-1843c74c4ab3';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'credentials' => [
                'nesciunt',
            ],
            'status_uuid' => 'f2cc735b-3b89-3153-b6f4-54ed092b6a76',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/a2ae559d-cd43-3807-a130-1843c74c4ab3"
);

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

let body = {
    "credentials": [
        "nesciunt"
    ],
    "status_uuid": "f2cc735b-3b89-3153-b6f4-54ed092b6a76"
};

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: a2ae559d-cd43-3807-a130-1843c74c4ab3

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: f2cc735b-3b89-3153-b6f4-54ed092b6a76

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/76784f73-ad74-39d5-bb40-e8e2f49e9623" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"credentials\": [
        \"ullam\"
    ],
    \"status_uuid\": \"a6fd43f1-58c2-3d64-9d52-7379abc14fa4\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/integrations/76784f73-ad74-39d5-bb40-e8e2f49e9623';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'credentials' => [
                'ullam',
            ],
            'status_uuid' => 'a6fd43f1-58c2-3d64-9d52-7379abc14fa4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/integrations/76784f73-ad74-39d5-bb40-e8e2f49e9623"
);

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

let body = {
    "credentials": [
        "ullam"
    ],
    "status_uuid": "a6fd43f1-58c2-3d64-9d52-7379abc14fa4"
};

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: 76784f73-ad74-39d5-bb40-e8e2f49e9623

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: a6fd43f1-58c2-3d64-9d52-7379abc14fa4

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/0919c63b-f8ff-3400-bb8e-37dfae07639a" \
    --header "Authorization: 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/0919c63b-f8ff-3400-bb8e-37dfae07639a';
$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/0919c63b-f8ff-3400-bb8e-37dfae07639a"
);

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: 0919c63b-f8ff-3400-bb8e-37dfae07639a

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: qui

sort_order   string  optional  

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

search   string  optional  

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

with_trashed   string  optional  

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

category_uuids   string  optional  

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

Show

requires authentication

Show a single company symbol.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/symbols/485f7744-2257-3ae5-a4fa-0c8040782463" \
    --header "Authorization: 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/485f7744-2257-3ae5-a4fa-0c8040782463';
$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/485f7744-2257-3ae5-a4fa-0c8040782463"
);

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: 485f7744-2257-3ae5-a4fa-0c8040782463

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=eveniet"\
    --form "source=ut"\
    --form "description=Ducimus nulla corporis rerum labore ut excepturi perspiciatis."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=quo"\
    --form "icon_file=@/tmp/phpmGQzXW" 
$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' => 'eveniet'
            ],
            [
                'name' => 'source',
                'contents' => 'ut'
            ],
            [
                'name' => 'description',
                'contents' => 'Ducimus nulla corporis rerum labore ut excepturi perspiciatis.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'quo'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpmGQzXW', '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', 'eveniet');
body.append('source', 'ut');
body.append('description', 'Ducimus nulla corporis rerum labore ut excepturi perspiciatis.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'quo');
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: eveniet

source   string   

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

description   string  optional  

optional The description of the symbol. Example : text Example: Ducimus nulla corporis rerum labore ut excepturi perspiciatis.

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

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/c45b7cc3-cd2f-3706-8815-8de3e39b9b62" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=esse"\
    --form "source=et"\
    --form "description=Nisi reiciendis enim reprehenderit reiciendis officiis hic."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=autem"\
    --form "icon_file=@/tmp/phpv6puqV" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/c45b7cc3-cd2f-3706-8815-8de3e39b9b62';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'esse'
            ],
            [
                'name' => 'source',
                'contents' => 'et'
            ],
            [
                'name' => 'description',
                'contents' => 'Nisi reiciendis enim reprehenderit reiciendis officiis hic.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'autem'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpv6puqV', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/c45b7cc3-cd2f-3706-8815-8de3e39b9b62"
);

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

const body = new FormData();
body.append('name', 'esse');
body.append('source', 'et');
body.append('description', 'Nisi reiciendis enim reprehenderit reiciendis officiis hic.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'autem');
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: c45b7cc3-cd2f-3706-8815-8de3e39b9b62

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

source   string   

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

description   string  optional  

optional The description of the symbol. Example : text Example: Nisi reiciendis enim reprehenderit reiciendis officiis hic.

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

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/f7e5c70a-6de7-3851-a444-fda1a9bc6344" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=ea"\
    --form "source=nam"\
    --form "description=Ipsum facere dolore molestiae eos voluptates non."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "company_product_uuids[]=et"\
    --form "icon_file=@/tmp/phpFRB2uU" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/f7e5c70a-6de7-3851-a444-fda1a9bc6344';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'ea'
            ],
            [
                'name' => 'source',
                'contents' => 'nam'
            ],
            [
                'name' => 'description',
                'contents' => 'Ipsum facere dolore molestiae eos voluptates non.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'company_product_uuids[]',
                'contents' => 'et'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpFRB2uU', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/f7e5c70a-6de7-3851-a444-fda1a9bc6344"
);

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

const body = new FormData();
body.append('name', 'ea');
body.append('source', 'nam');
body.append('description', 'Ipsum facere dolore molestiae eos voluptates non.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'et');
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: f7e5c70a-6de7-3851-a444-fda1a9bc6344

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

source   string   

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

description   string  optional  

optional The description of the symbol. Example : text Example: Ipsum facere dolore molestiae eos voluptates non.

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

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/0440f7ee-6678-3ff6-822d-08269496e926" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=sit"\
    --form "source=maiores"\
    --form "description=Accusantium quod qui doloremque culpa rerum."\
    --form "icon_url=http://smarterlaunch.local/image1.jpg"\
    --form "icon_file=@/tmp/phpCD2JeV" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/symbols/0440f7ee-6678-3ff6-822d-08269496e926';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'sit'
            ],
            [
                'name' => 'source',
                'contents' => 'maiores'
            ],
            [
                'name' => 'description',
                'contents' => 'Accusantium quod qui doloremque culpa rerum.'
            ],
            [
                'name' => 'icon_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'icon_file',
                'contents' => fopen('/tmp/phpCD2JeV', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/0440f7ee-6678-3ff6-822d-08269496e926"
);

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

const body = new FormData();
body.append('name', 'sit');
body.append('source', 'maiores');
body.append('description', 'Accusantium quod qui doloremque culpa rerum.');
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: 0440f7ee-6678-3ff6-822d-08269496e926

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

source   string   

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

description   string  optional  

optional The description of the symbol. Example : text Example: Accusantium quod qui doloremque culpa rerum.

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

Delete

requires authentication

Delete a company symbol.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/symbols/3c5e4c36-0b75-38a9-8d05-8b93ae8dac82" \
    --header "Authorization: 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/3c5e4c36-0b75-38a9-8d05-8b93ae8dac82';
$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/3c5e4c36-0b75-38a9-8d05-8b93ae8dac82"
);

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: 3c5e4c36-0b75-38a9-8d05-8b93ae8dac82

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/e7a1bbab-c1d0-3317-b2aa-766ab6f63342" \
    --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/phpl2AppT" \
    --form "photo_file=@/tmp/phplxOgmW" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/support-request-upload/e7a1bbab-c1d0-3317-b2aa-766ab6f63342';
$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/phpl2AppT', 'r')
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phplxOgmW', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/support-request-upload/e7a1bbab-c1d0-3317-b2aa-766ab6f63342"
);

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: e7a1bbab-c1d0-3317-b2aa-766ab6f63342

Body Parameters

screenshot_file   file   

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

document_template_page_title   string   

The template page title. Example: Cover Letter

photo_file   file   

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

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

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

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

Show

requires authentication

Show a single pest treated.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/51a1d59c-18f3-37ea-bd4d-d0918d436751" \
    --header "Authorization: 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/51a1d59c-18f3-37ea-bd4d-d0918d436751';
$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/51a1d59c-18f3-37ea-bd4d-d0918d436751"
);

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: 51a1d59c-18f3-37ea-bd4d-d0918d436751

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

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

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

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

const body = new FormData();
body.append('name', 'vel');
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: eb1e1a7a-a1ef-3180-a389-d28717c52b7c

Body Parameters

name   string   

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

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

Update

requires authentication

Update a pest treated.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/2e67ce05-70b8-3dff-b417-4b089861c9fe" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=iusto"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phpt3SBiV" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/2e67ce05-70b8-3dff-b417-4b089861c9fe';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'iusto'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpt3SBiV', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/2e67ce05-70b8-3dff-b417-4b089861c9fe"
);

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

const body = new FormData();
body.append('name', 'iusto');
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: 2e67ce05-70b8-3dff-b417-4b089861c9fe

Body Parameters

name   string   

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

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

Patch

requires authentication

Patch a company pest treated.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/990ddef1-421d-35f2-812b-743fec3a13f2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=suscipit"\
    --form "pest_treated_attributes[attr]=value"\
    --form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
    --form "photo_file=@/tmp/phpJby9YT" 
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/990ddef1-421d-35f2-812b-743fec3a13f2';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'name',
                'contents' => 'suscipit'
            ],
            [
                'name' => 'pest_treated_attributes[attr]',
                'contents' => 'value'
            ],
            [
                'name' => 'icon_image_url',
                'contents' => 'http://smarterlaunch.local/image1.jpg'
            ],
            [
                'name' => 'photo_file',
                'contents' => fopen('/tmp/phpJby9YT', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/990ddef1-421d-35f2-812b-743fec3a13f2"
);

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

const body = new FormData();
body.append('name', 'suscipit');
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: 990ddef1-421d-35f2-812b-743fec3a13f2

Body Parameters

name   string  optional  

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

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

Delete

requires authentication

Delete a pest treated.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/companies/1/pests-treated/61d43352-89c8-33a5-ac9d-a5d709c94121" \
    --header "Authorization: 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/61d43352-89c8-33a5-ac9d-a5d709c94121';
$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/61d43352-89c8-33a5-ac9d-a5d709c94121"
);

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: 61d43352-89c8-33a5-ac9d-a5d709c94121

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"neque\",
    \"description\": \"Quibusdam occaecati dignissimos esse iusto qui.\"
}"

$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' => 'neque',
            'description' => 'Quibusdam occaecati dignissimos esse iusto qui.',
        ],
    ]
);
$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": "neque",
    "description": "Quibusdam occaecati dignissimos esse iusto qui."
};

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

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Quibusdam occaecati dignissimos esse iusto qui.

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\": \"excepturi\",
    \"description\": \"Pariatur corrupti aut distinctio quasi.\"
}"

$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' => 'excepturi',
            'description' => 'Pariatur corrupti aut distinctio quasi.',
        ],
    ]
);
$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": "excepturi",
    "description": "Pariatur corrupti aut distinctio quasi."
};

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

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Pariatur corrupti aut distinctio quasi.

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\": \"tenetur\",
    \"description\": \"Dolor ipsum quisquam delectus aut.\"
}"

$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' => 'tenetur',
            'description' => 'Dolor ipsum quisquam delectus aut.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1/favorites"
);

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

let body = {
    "name": "tenetur",
    "description": "Dolor ipsum quisquam delectus aut."
};

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

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Dolor ipsum quisquam delectus aut.

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

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\": \"vitae\",
    \"description\": \"Facilis rem facere omnis voluptatem porro autem.\"
}"

$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' => 'vitae',
            'description' => 'Facilis rem facere omnis voluptatem porro autem.',
        ],
    ]
);
$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": "vitae",
    "description": "Facilis rem facere omnis voluptatem porro autem."
};

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

description   string  optional  

The description of the media source. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Facilis rem facere omnis voluptatem porro autem.

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\": \"accusamus\",
    \"description\": \"Sit rem occaecati saepe dolor enim sint doloremque sunt.\"
}"

$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' => 'accusamus',
            'description' => 'Sit rem occaecati saepe dolor enim sint doloremque sunt.',
        ],
    ]
);
$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": "accusamus",
    "description": "Sit rem occaecati saepe dolor enim sint doloremque sunt."
};

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

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 rem occaecati saepe dolor enim sint doloremque sunt.

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\": \"quo\",
    \"description\": \"Quis eos laudantium officiis maxime deserunt consectetur aut.\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/media-sources/1/favorites';
$response = $client->delete(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quo',
            'description' => 'Quis eos laudantium officiis maxime deserunt consectetur aut.',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/media-sources/1/favorites"
);

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

let body = {
    "name": "quo",
    "description": "Quis eos laudantium officiis maxime deserunt consectetur aut."
};

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

Request      

DELETE api/v1/media-sources/{mediaSource_uuid}/favorites

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

mediaSource_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the media source. Example : "My media source" Example: 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: Quis eos laudantium officiis maxime deserunt consectetur aut.

Proposal Templates

List

requires authentication

Shows the list of ProposalTemplates with pagination.

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

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

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

Request      

GET api/v1/proposals/templates

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 10

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

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

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\": \"59f60513-9a51-3020-a3c1-36e6f1333433\",
    \"title\": \"voluptatem\",
    \"description\": \"Rerum vitae voluptatem quaerat quaerat odio voluptates veniam totam.\",
    \"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' => '59f60513-9a51-3020-a3c1-36e6f1333433',
            'title' => 'voluptatem',
            'description' => 'Rerum vitae voluptatem quaerat quaerat odio voluptates veniam totam.',
            '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": "59f60513-9a51-3020-a3c1-36e6f1333433",
    "title": "voluptatem",
    "description": "Rerum vitae voluptatem quaerat quaerat odio voluptates veniam totam.",
    "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: 59f60513-9a51-3020-a3c1-36e6f1333433

title   string   

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

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Rerum vitae voluptatem quaerat quaerat odio voluptates veniam totam.

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/c32f1fc1-8914-3e93-8894-c29048d7a0c3/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/c32f1fc1-8914-3e93-8894-c29048d7a0c3/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/c32f1fc1-8914-3e93-8894-c29048d7a0c3/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: c32f1fc1-8914-3e93-8894-c29048d7a0c3

Show

requires authentication

Show a single proposal template.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/proposals/templates/16e8d986-e911-3792-bd59-cdc0646414b2" \
    --header "Authorization: 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/16e8d986-e911-3792-bd59-cdc0646414b2';
$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/16e8d986-e911-3792-bd59-cdc0646414b2"
);

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: 16e8d986-e911-3792-bd59-cdc0646414b2

Update

requires authentication

Update a proposal template.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/templates/e236a50e-bcd1-3770-976f-02cd0683ca0a" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"066046e3-6bff-3757-9ff0-9c05e9b6d6cc\",
    \"title\": \"velit\",
    \"description\": \"Tempore accusantium et quis.\",
    \"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/e236a50e-bcd1-3770-976f-02cd0683ca0a';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => '066046e3-6bff-3757-9ff0-9c05e9b6d6cc',
            'title' => 'velit',
            'description' => 'Tempore accusantium et quis.',
            '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/e236a50e-bcd1-3770-976f-02cd0683ca0a"
);

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

let body = {
    "company_location_uuid": "066046e3-6bff-3757-9ff0-9c05e9b6d6cc",
    "title": "velit",
    "description": "Tempore accusantium et quis.",
    "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: e236a50e-bcd1-3770-976f-02cd0683ca0a

Body Parameters

company_location_uuid   string   

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 066046e3-6bff-3757-9ff0-9c05e9b6d6cc

title   string   

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

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Tempore accusantium et quis.

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/f1b90b36-8878-32be-b456-f70c2cc21330" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"company_location_uuid\": \"a2d6aa72-d895-335d-b5df-60e9e515e762\",
    \"title\": \"enim\",
    \"description\": \"Animi repellat minima atque provident.\",
    \"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/f1b90b36-8878-32be-b456-f70c2cc21330';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'company_location_uuid' => 'a2d6aa72-d895-335d-b5df-60e9e515e762',
            'title' => 'enim',
            'description' => 'Animi repellat minima atque provident.',
            '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/f1b90b36-8878-32be-b456-f70c2cc21330"
);

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

let body = {
    "company_location_uuid": "a2d6aa72-d895-335d-b5df-60e9e515e762",
    "title": "enim",
    "description": "Animi repellat minima atque provident.",
    "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: f1b90b36-8878-32be-b456-f70c2cc21330

Body Parameters

company_location_uuid   string  optional  

The uuid of company location for proposal template. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: a2d6aa72-d895-335d-b5df-60e9e515e762

title   string  optional  

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

description   string  optional  

The name of the proposal template. Example : This is a sample description Example: Animi repellat minima atque provident.

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/e223c66c-74c1-3412-a37f-fa114934cd8b" \
    --header "Authorization: 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/e223c66c-74c1-3412-a37f-fa114934cd8b';
$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/e223c66c-74c1-3412-a37f-fa114934cd8b"
);

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: e223c66c-74c1-3412-a37f-fa114934cd8b

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\": \"67786025-d95f-3721-b63d-84fc58626767\",
    \"company_location_uuid\": \"c8fc59a1-6f81-3de3-8875-720eab3a13e8\",
    \"media_source_uuid\": \"823f5f8b-3a06-30d7-a692-be8400db43bf\",
    \"include_global_files\": false
}"

$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' => '67786025-d95f-3721-b63d-84fc58626767',
            'company_location_uuid' => 'c8fc59a1-6f81-3de3-8875-720eab3a13e8',
            'media_source_uuid' => '823f5f8b-3a06-30d7-a692-be8400db43bf',
            'include_global_files' => false,
        ],
    ]
);
$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": "67786025-d95f-3721-b63d-84fc58626767",
    "company_location_uuid": "c8fc59a1-6f81-3de3-8875-720eab3a13e8",
    "media_source_uuid": "823f5f8b-3a06-30d7-a692-be8400db43bf",
    "include_global_files": false
};

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: incidunt

sort_order   string  optional  

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

search   string  optional  

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

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: 67786025-d95f-3721-b63d-84fc58626767

companies_uuid   object  optional  
company_location_uuid   string  optional  

Must be a valid UUID. Example: c8fc59a1-6f81-3de3-8875-720eab3a13e8

company_locations_uuid   object  optional  
media_source_uuid   string  optional  

Must be a valid UUID. Example: 823f5f8b-3a06-30d7-a692-be8400db43bf

include_global_files   boolean  optional  

Example: false

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=aut"\
    --form "description=Cum incidunt quasi voluptas."\
    --form "directory=proposal-template"\
    --form "type=document"\
    --form "fileUpload=@/tmp/phpUYHKzU" 
$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' => 'aut'
            ],
            [
                'name' => 'description',
                'contents' => 'Cum incidunt quasi voluptas.'
            ],
            [
                'name' => 'directory',
                'contents' => 'proposal-template'
            ],
            [
                'name' => 'type',
                'contents' => 'document'
            ],
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phpUYHKzU', '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', 'aut');
body.append('description', 'Cum incidunt quasi voluptas.');
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: aut

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Cum incidunt quasi voluptas.

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

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\": \"voluptas\",
    \"description\": \"Vel sed sed dolorem est odio rerum ad.\"
}"

$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' => 'voluptas',
            'description' => 'Vel sed sed dolorem est odio rerum ad.',
        ],
    ]
);
$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": "voluptas",
    "description": "Vel sed sed dolorem est odio rerum ad."
};

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

description   string  optional  

The description of the media item. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Vel sed sed dolorem est odio rerum ad.

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\": \"delectus\",
    \"description\": \"Commodi mollitia sed voluptatem.\"
}"

$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' => 'delectus',
            'description' => 'Commodi mollitia sed voluptatem.',
        ],
    ]
);
$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": "delectus",
    "description": "Commodi mollitia sed voluptatem."
};

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

description   string  optional  

The description of the media item. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Commodi mollitia sed voluptatem.

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: eius

sort_order   string  optional  

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

search   string  optional  

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

Show

requires authentication

Show a single company product.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/companies/1/products/6a33e180-bfdd-388d-a18a-abb54993ba61" \
    --header "Authorization: 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/6a33e180-bfdd-388d-a18a-abb54993ba61';
$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/6a33e180-bfdd-388d-a18a-abb54993ba61"
);

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: 6a33e180-bfdd-388d-a18a-abb54993ba61

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

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/7b8c89e3-41e2-32a0-99a6-ccc7c26f1262" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"minima\",
    \"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/7b8c89e3-41e2-32a0-99a6-ccc7c26f1262';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'minima',
            '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/7b8c89e3-41e2-32a0-99a6-ccc7c26f1262"
);

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

let body = {
    "name": "minima",
    "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: 7b8c89e3-41e2-32a0-99a6-ccc7c26f1262

Body Parameters

name   string   

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

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/195f0bd8-4cd6-3077-9bc5-3b68be7642ef" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"quo\",
    \"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/195f0bd8-4cd6-3077-9bc5-3b68be7642ef';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'quo',
            '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/195f0bd8-4cd6-3077-9bc5-3b68be7642ef"
);

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

let body = {
    "name": "quo",
    "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: 195f0bd8-4cd6-3077-9bc5-3b68be7642ef

Body Parameters

name   string  optional  

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

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/b747c8d1-a497-342e-881a-666a121f470b" \
    --header "Authorization: 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/b747c8d1-a497-342e-881a-666a121f470b';
$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/b747c8d1-a497-342e-881a-666a121f470b"
);

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: b747c8d1-a497-342e-881a-666a121f470b

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

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

sort_order   string  optional  

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

search   string  optional  

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

Permission

API for permission details

List / Fetch

requires authentication

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

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

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

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

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

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

Request      

GET api/v1/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

uuid   string  optional  

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

name   string   

The name of the permission. Example: user-list

List / Fetch

requires authentication

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

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

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

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

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

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

Request      

GET api/v1/permissions/{permissionUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionUuid   integer   

Example: 1

Body Parameters

uuid   string  optional  

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

name   string   

The name of the permission. Example: user-list

Create / Update permission.

requires authentication

This endpoint lets user to create/update permission.

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

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

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

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

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

Request      

POST api/v1/permissions

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the permission. Example: user-list

uuid   string  optional  

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

Create / Update permission.

requires authentication

This endpoint lets user to create/update permission.

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

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

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

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

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

Request      

PUT api/v1/permissions/{permissionUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionUuid   integer   

Example: 1

Body Parameters

name   string   

The name of the permission. Example: user-list

uuid   string  optional  

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

Delete

requires authentication

This endpoint allows user to delete permission.

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

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

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

Request      

DELETE api/v1/permissions/{permissionUuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

permissionUuid   integer   

Example: 1

uuid   string   

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

Company File

API for Company File

Store

requires authentication

Upload a file into a company

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/files" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "name=similique"\
    --form "description=Eius nihil cupiditate ut qui officiis ex mollitia."\
    --form "directory=proposal-template"\
    --form "type=document"\
    --form "fileUpload=@/tmp/phpnmqv0U" 
$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' => 'similique'
            ],
            [
                'name' => 'description',
                'contents' => 'Eius nihil cupiditate ut qui officiis ex mollitia.'
            ],
            [
                'name' => 'directory',
                'contents' => 'proposal-template'
            ],
            [
                'name' => 'type',
                'contents' => 'document'
            ],
            [
                'name' => 'fileUpload',
                'contents' => fopen('/tmp/phpnmqv0U', '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', 'similique');
body.append('description', 'Eius nihil cupiditate ut qui officiis ex mollitia.');
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: similique

description   string  optional  

The description of the file. Example : This is a sample description for uploaded file Example: Eius nihil cupiditate ut qui officiis ex mollitia.

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

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:\\/\\/www.braun.net\\/quia-suscipit-suscipit-quos-autem-corporis-suscipit.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://www.braun.net/quia-suscipit-suscipit-quos-autem-corporis-suscipit.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:\/\/www.braun.net\/quia-suscipit-suscipit-quos-autem-corporis-suscipit.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://www.braun.net/quia-suscipit-suscipit-quos-autem-corporis-suscipit.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/47f0b194-ed5d-3bac-9612-76d991f1262c" \
    --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/47f0b194-ed5d-3bac-9612-76d991f1262c';
$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/47f0b194-ed5d-3bac-9612-76d991f1262c"
);

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: 47f0b194-ed5d-3bac-9612-76d991f1262c

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/8e3c06fb-7713-37b1-bd19-45b80600c73c/states" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/countries/8e3c06fb-7713-37b1-bd19-45b80600c73c/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/8e3c06fb-7713-37b1-bd19-45b80600c73c/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: 8e3c06fb-7713-37b1-bd19-45b80600c73c

country_uuid   string   

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

Solution Category

API for Solution Category

List

requires authentication

Shows the list of solution categories.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solution-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"include_fields\": [
        \"solutions\"
    ],
    \"ignore_cached\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solution-categories';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'include_fields' => [
                'solutions',
            ],
            'ignore_cached' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solution-categories"
);

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

let body = {
    "include_fields": [
        "solutions"
    ],
    "ignore_cached": true
};

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

Request      

GET api/v1/solution-categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 13

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

sort_order   string  optional  

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

search   string  optional  

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

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

Body Parameters

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

Example: true

Show

requires authentication

Show a single solution category.

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

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

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

Request      

GET api/v1/solution-categories/{solutionCategory_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solutionCategory_uuid   integer   

Example: 1

Store

requires authentication

Store a new solution category.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/solution-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"doloribus\",
    \"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' => 'doloribus',
            '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": "doloribus",
    "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: doloribus

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

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

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

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

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

sort_order   string  optional  

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

search   string  optional  

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

Show

requires authentication

Show a single solution.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/41ddfa4f-22bf-383a-bbe3-601deef15767" \
    --header "Authorization: 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/41ddfa4f-22bf-383a-bbe3-601deef15767';
$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/41ddfa4f-22bf-383a-bbe3-601deef15767"
);

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: 41ddfa4f-22bf-383a-bbe3-601deef15767

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

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/b79d35cc-a49f-322b-8101-a83b7439bad4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 19,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/b79d35cc-a49f-322b-8101-a83b7439bad4';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 19,
            'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/b79d35cc-a49f-322b-8101-a83b7439bad4"
);

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

let body = {
    "rate": 19,
    "feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};

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

Request      

PUT api/v1/solutions/{solution_uuid}/feedback/{solutionFeedback_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

solution_uuid   integer   

Example: 1

solutionFeedback_uuid   string   

Example: b79d35cc-a49f-322b-8101-a83b7439bad4

Body Parameters

rate   integer   

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

feedback   string  optional  

The attributes of the solution. Example: "Lorem ipsum dolor sit amet consectetur adipisicing elit."

Patch

requires authentication

Patch a solution feedback.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/solutions/1/feedback/cf72afea-8043-3189-ba8f-c8bdd4eada82" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rate\": 12,
    \"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/solutions/1/feedback/cf72afea-8043-3189-ba8f-c8bdd4eada82';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'rate' => 12,
            '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/cf72afea-8043-3189-ba8f-c8bdd4eada82"
);

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

let body = {
    "rate": 12,
    "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: cf72afea-8043-3189-ba8f-c8bdd4eada82

Body Parameters

rate   integer   

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

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/fc3bf36b-5a6f-3db8-9957-8dbc87604a62" \
    --header "Authorization: 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/fc3bf36b-5a6f-3db8-9957-8dbc87604a62';
$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/fc3bf36b-5a6f-3db8-9957-8dbc87604a62"
);

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: fc3bf36b-5a6f-3db8-9957-8dbc87604a62

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

should_reset_cache   boolean  optional  

optional Resets the cache Example: false

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\": \"4ca32219-44e9-324f-9dc7-f97f5bd84e6f\",
    \"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' => '4ca32219-44e9-324f-9dc7-f97f5bd84e6f',
            '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": "4ca32219-44e9-324f-9dc7-f97f5bd84e6f",
    "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: 4ca32219-44e9-324f-9dc7-f97f5bd84e6f

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: voluptates

sort_order   string  optional  

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

search   string  optional  

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

with_trashed   string  optional  

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

assignment   string  optional  

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

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/2c58f8ca-7096-393c-9d40-f8925d5c1651" \
    --header "Authorization: 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/2c58f8ca-7096-393c-9d40-f8925d5c1651';
$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/2c58f8ca-7096-393c-9d40-f8925d5c1651"
);

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: 2c58f8ca-7096-393c-9d40-f8925d5c1651

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\": \"laudantium\",
    \"assignment\": \"harum\",
    \"company_custom_fields\": [
        \"veniam\"
    ]
}"

$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' => 'laudantium',
            'assignment' => 'harum',
            'company_custom_fields' => [
                'veniam',
            ],
        ],
    ]
);
$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": "laudantium",
    "assignment": "harum",
    "company_custom_fields": [
        "veniam"
    ]
};

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

assignment   enum  optional  

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

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/77215c5c-4976-3d0e-8922-7d81d493edb5" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"laboriosam\",
    \"assignment\": \"necessitatibus\",
    \"company_custom_fields\": [
        \"assumenda\"
    ],
    \"deleted_custom_field_uuids\": [
        \"repudiandae\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/77215c5c-4976-3d0e-8922-7d81d493edb5';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'laboriosam',
            'assignment' => 'necessitatibus',
            'company_custom_fields' => [
                'assumenda',
            ],
            'deleted_custom_field_uuids' => [
                'repudiandae',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/77215c5c-4976-3d0e-8922-7d81d493edb5"
);

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

let body = {
    "name": "laboriosam",
    "assignment": "necessitatibus",
    "company_custom_fields": [
        "assumenda"
    ],
    "deleted_custom_field_uuids": [
        "repudiandae"
    ]
};

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: 77215c5c-4976-3d0e-8922-7d81d493edb5

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

assignment   enum  optional  

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

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/dd152e14-2077-3b2d-8047-c7ecd354f484" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"non\",
    \"assignment\": \"ex\",
    \"company_custom_fields\": [
        \"necessitatibus\"
    ],
    \"deleted_custom_field_uuids\": [
        \"nostrum\"
    ]
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/dd152e14-2077-3b2d-8047-c7ecd354f484';
$response = $client->patch(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'name' => 'non',
            'assignment' => 'ex',
            'company_custom_fields' => [
                'necessitatibus',
            ],
            'deleted_custom_field_uuids' => [
                'nostrum',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/custom-field-groups/dd152e14-2077-3b2d-8047-c7ecd354f484"
);

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

let body = {
    "name": "non",
    "assignment": "ex",
    "company_custom_fields": [
        "necessitatibus"
    ],
    "deleted_custom_field_uuids": [
        "nostrum"
    ]
};

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: dd152e14-2077-3b2d-8047-c7ecd354f484

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

assignment   enum  optional  

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

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/7d5912cd-6b3d-3208-9870-c1bde3ec5215" \
    --header "Authorization: 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/7d5912cd-6b3d-3208-9870-c1bde3ec5215';
$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/7d5912cd-6b3d-3208-9870-c1bde3ec5215"
);

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: 7d5912cd-6b3d-3208-9870-c1bde3ec5215

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:\\/\\/zemlak.org\\/\"
}"

$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://zemlak.org/',
        ],
    ]
);
$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:\/\/zemlak.org\/"
};

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://zemlak.org/

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"Numquam est ut ratione doloremque.\",
    \"line_item_values\": \"veritatis\"
}"

$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' => 'Numquam est ut ratione doloremque.',
            'line_item_values' => 'veritatis',
        ],
    ]
);
$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": "Numquam est ut ratione doloremque.",
    "line_item_values": "veritatis"
};

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: Numquam est ut ratione doloremque.

line_item_values   string   

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

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

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\": \"nesciunt\",
    \"description\": \"Exercitationem nobis ut aut alias rerum ullam quasi deleniti.\",
    \"line_item_values\": \"doloribus\"
}"

$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' => 'nesciunt',
            'description' => 'Exercitationem nobis ut aut alias rerum ullam quasi deleniti.',
            'line_item_values' => 'doloribus',
        ],
    ]
);
$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": "nesciunt",
    "description": "Exercitationem nobis ut aut alias rerum ullam quasi deleniti.",
    "line_item_values": "doloribus"
};

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

description   string  optional  

The description of the line item. Example : "Termite Pesticide" Example: Exercitationem nobis ut aut alias rerum ullam quasi deleniti.

line_item_values   string   

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

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\": \"voluptate\",
    \"description\": \"Voluptatem et sit mollitia aut consequatur molestiae inventore.\",
    \"line_item_values\": \"omnis\"
}"

$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' => 'voluptate',
            'description' => 'Voluptatem et sit mollitia aut consequatur molestiae inventore.',
            'line_item_values' => 'omnis',
        ],
    ]
);
$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": "voluptate",
    "description": "Voluptatem et sit mollitia aut consequatur molestiae inventore.",
    "line_item_values": "omnis"
};

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

description   string  optional  

The description of the line item. Example : "Termite Pesticide" Example: Voluptatem et sit mollitia aut consequatur molestiae inventore.

line_item_values   string   

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

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"molestias\"
}"

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

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

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\": \"quidem\"
}"

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

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

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\": \"voluptate\"
}"

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

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

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : title Example: ab

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

filter_by_uuids   string  optional  

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

groups   string  optional  

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

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/de449699-8838-3016-aecb-c27b9b2e9b09" \
    --header "Authorization: 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/de449699-8838-3016-aecb-c27b9b2e9b09';
$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/de449699-8838-3016-aecb-c27b9b2e9b09"
);

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: de449699-8838-3016-aecb-c27b9b2e9b09

Delete

requires authentication

Delete a report template.

Example request:
curl --request DELETE \
    "https://api.smarterlaunch.com/api/v1/reports/templates/bb7b1e54-cb57-3926-8ce5-1b5ae0f78572" \
    --header "Authorization: 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/bb7b1e54-cb57-3926-8ce5-1b5ae0f78572';
$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/bb7b1e54-cb57-3926-8ce5-1b5ae0f78572"
);

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: bb7b1e54-cb57-3926-8ce5-1b5ae0f78572

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

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

search   string  optional  

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

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/79629e29-bd58-3b46-a4f2-065187cdf9e1" \
    --header "Authorization: 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/79629e29-bd58-3b46-a4f2-065187cdf9e1';
$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/79629e29-bd58-3b46-a4f2-065187cdf9e1"
);

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: 79629e29-bd58-3b46-a4f2-065187cdf9e1

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

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

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

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

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\": [
        \"expedita\"
    ],
    \"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' => [
                'expedita',
            ],
            '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": [
        "expedita"
    ],
    "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/a8ebe537-2c71-35db-adb6-1daf8db8217a" \
    --header "Authorization: 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/a8ebe537-2c71-35db-adb6-1daf8db8217a';
$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/a8ebe537-2c71-35db-adb6-1daf8db8217a"
);

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: a8ebe537-2c71-35db-adb6-1daf8db8217a

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/34648688-4628-3bbc-8b5b-08dd024340bc" \
    --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/34648688-4628-3bbc-8b5b-08dd024340bc';
$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/34648688-4628-3bbc-8b5b-08dd024340bc"
);

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: 34648688-4628-3bbc-8b5b-08dd024340bc

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/941b85bd-0093-3670-8bc3-8cd0a6a38ea5" \
    --header "Authorization: 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/941b85bd-0093-3670-8bc3-8cd0a6a38ea5';
$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/941b85bd-0093-3670-8bc3-8cd0a6a38ea5"
);

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: 941b85bd-0093-3670-8bc3-8cd0a6a38ea5

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

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

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 : "Categories" Example: voluptas

name   string  optional  

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

code   string  optional  

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

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/6d68d966-5a28-3f32-a4f7-5b1e92c6dc8d/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/6d68d966-5a28-3f32-a4f7-5b1e92c6dc8d/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/6d68d966-5a28-3f32-a4f7-5b1e92c6dc8d/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: 6d68d966-5a28-3f32-a4f7-5b1e92c6dc8d

Body Parameters

screenshot_url   string   

The url of the attached image. Example: https://example.net/test.png

Accept and Sign

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/accept-sign" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"signature_photo_url\": \"http:\\/\\/www.lang.com\\/quia-quos-quod-qui-libero-et\",
    \"proposal_pdf_url\": \"http:\\/\\/www.oreilly.com\\/ut-dolorem-nam-sunt-quas.html\",
    \"auth_code\": \"et\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/accept-sign';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'signature_photo_url' => 'http://www.lang.com/quia-quos-quod-qui-libero-et',
            'proposal_pdf_url' => 'http://www.oreilly.com/ut-dolorem-nam-sunt-quas.html',
            'auth_code' => 'et',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/accept-sign"
);

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

let body = {
    "signature_photo_url": "http:\/\/www.lang.com\/quia-quos-quod-qui-libero-et",
    "proposal_pdf_url": "http:\/\/www.oreilly.com\/ut-dolorem-nam-sunt-quas.html",
    "auth_code": "et"
};

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

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/accept-sign

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

accepted_confirmation_uuids   object  optional  
signature_photo_url   string   

The image url. Example: http://www.lang.com/quia-quos-quod-qui-libero-et

proposal_pdf_url   string   

The pdf file url. Example: http://www.oreilly.com/ut-dolorem-nam-sunt-quas.html

auth_code   string  optional  

Example: et

Replicate Signature

requires authentication

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/replace-signature" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"signature_photo_url\": \"http:\\/\\/www.hand.com\\/est-repudiandae-molestias-quo-itaque-vitae-consequatur-alias-dolorem\",
    \"proposal_pdf_url\": \"http:\\/\\/steuber.com\\/\"
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/replace-signature';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'signature_photo_url' => 'http://www.hand.com/est-repudiandae-molestias-quo-itaque-vitae-consequatur-alias-dolorem',
            'proposal_pdf_url' => 'http://steuber.com/',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/proposals/15/replace-signature"
);

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

let body = {
    "signature_photo_url": "http:\/\/www.hand.com\/est-repudiandae-molestias-quo-itaque-vitae-consequatur-alias-dolorem",
    "proposal_pdf_url": "http:\/\/steuber.com\/"
};

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

Request      

POST api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/replace-signature

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

proposal_uuid   integer   

Example: 15

Body Parameters

signature_photo_url   string   

The image url. Example: http://www.hand.com/est-repudiandae-molestias-quo-itaque-vitae-consequatur-alias-dolorem

proposal_pdf_url   string   

The pdf file url. Example: http://steuber.com/

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

documentIndex   number  optional  

The document index number. Example : 1 Example: 1958032.7

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\": \"occaecati\"
}"

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

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

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\": false,
    \"date_range_start\": \"2025-09-30T05:15:15\",
    \"date_range_end\": \"2078-03-02\",
    \"timezone\": \"Asia\\/Amman\"
}"

$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' => false,
            'date_range_start' => '2025-09-30T05:15:15',
            'date_range_end' => '2078-03-02',
            'timezone' => 'Asia/Amman',
        ],
    ]
);
$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": false,
    "date_range_start": "2025-09-30T05:15:15",
    "date_range_end": "2078-03-02",
    "timezone": "Asia\/Amman"
};

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: non

sort_order   string  optional  

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

search   string  optional  

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

search_by   string  optional  

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

company_location_uuid   string  optional  

The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 79dce31c-81e9-3c04-aa56-00a493d8236a

company_location_uuids   string  optional  

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

status_uuid   string  optional  

string[] The UUID of proposal status. Example : ["815d3d9c-f371-3781-8456-7e6954b5b0f5"] Example: bb1a9bc5-cbcc-33ee-af92-3f7b613ecd12

customer_uuid   string  optional  

The UUID of a customer. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 8f81d45a-0f50-3a74-9122-540f45bfae69

include_fields   string  optional  

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

user_uuid   string  optional  

Filter by the user that created proposals. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 4a9e0e87-07c7-3200-96cb-864e0b3078bc

timezone   string  optional  

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

date_range_start   string  optional  

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

date_range_end   string  optional  

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

date_range_type   string  optional  

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

Body Parameters

include_fields   string[]  optional  
ignore_cached   boolean  optional  

Example: false

date_range_start   string  optional  

Must be a valid date. Example: 2025-09-30T05:15:15

date_range_end   string  optional  

Must be a valid date. Must be a date after or equal to date_range_start. Example: 2078-03-02

timezone   string  optional  

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

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

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

sort_order   string  optional  

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

search   string  optional  

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

company_location_uuid   string  optional  

The UUID of company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 968ea535-29c3-3494-8075-341e59ebdada

company_location_uuids   string  optional  

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

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 332fbbad-6203-33f8-81cc-f3d3e593fa28

customer_uuid   string  optional  

The UUID of a customer. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: fcc03b40-6f93-3588-896f-79ae3afcf162

include_fields   string  optional  

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

user_uuid   string  optional  

Filter by the user that created proposals. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: a2cbe2fb-7414-36fb-aaff-10613201d8cb

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

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

sort_order   string  optional  

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

search   string  optional  

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

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/76cd39d0-2c51-3163-85f1-a42d6a13093e/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/76cd39d0-2c51-3163-85f1-a42d6a13093e/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/76cd39d0-2c51-3163-85f1-a42d6a13093e/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: 76cd39d0-2c51-3163-85f1-a42d6a13093e

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/43ca9b45-c1b2-3cbf-9b0f-e888681ee701/repellendus" \
    --header "Authorization: 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/43ca9b45-c1b2-3cbf-9b0f-e888681ee701/repellendus';
$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/43ca9b45-c1b2-3cbf-9b0f-e888681ee701/repellendus"
);

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: 43ca9b45-c1b2-3cbf-9b0f-e888681ee701

action   string   

Example: repellendus

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\": \"omnis\",
    \"description\": \"Adipisci ut ut hic occaecati ex omnis.\",
    \"company_location_uuid\": \"d3799fb1-d3d7-3c46-a98d-4ae66060b878\",
    \"customer_uuid\": \"aea3df20-c56c-342c-a638-b2c053191670\",
    \"customer_address_uuid\": \"1e36a4d5-1705-3723-a458-24a3264ecb4d\",
    \"status_uuid\": \"031e5186-0db2-3a1d-8164-2fd34e9644f9\",
    \"service_plan_uuids\": [
        \"est\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"e1b57bb7-d49e-3dc3-8f1e-2a4f83519acc\"
}"

$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' => 'omnis',
            'description' => 'Adipisci ut ut hic occaecati ex omnis.',
            'company_location_uuid' => 'd3799fb1-d3d7-3c46-a98d-4ae66060b878',
            'customer_uuid' => 'aea3df20-c56c-342c-a638-b2c053191670',
            'customer_address_uuid' => '1e36a4d5-1705-3723-a458-24a3264ecb4d',
            'status_uuid' => '031e5186-0db2-3a1d-8164-2fd34e9644f9',
            'service_plan_uuids' => [
                'est',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => 'e1b57bb7-d49e-3dc3-8f1e-2a4f83519acc',
        ],
    ]
);
$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": "omnis",
    "description": "Adipisci ut ut hic occaecati ex omnis.",
    "company_location_uuid": "d3799fb1-d3d7-3c46-a98d-4ae66060b878",
    "customer_uuid": "aea3df20-c56c-342c-a638-b2c053191670",
    "customer_address_uuid": "1e36a4d5-1705-3723-a458-24a3264ecb4d",
    "status_uuid": "031e5186-0db2-3a1d-8164-2fd34e9644f9",
    "service_plan_uuids": [
        "est"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "e1b57bb7-d49e-3dc3-8f1e-2a4f83519acc"
};

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

description   string  optional  

The paragraph describing the proposal. Example: Adipisci ut ut hic occaecati ex omnis.

company_location_uuid   string   

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: d3799fb1-d3d7-3c46-a98d-4ae66060b878

customer_uuid   string   

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: aea3df20-c56c-342c-a638-b2c053191670

customer_address_uuid   string   

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 1e36a4d5-1705-3723-a458-24a3264ecb4d

status_uuid   string   

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 031e5186-0db2-3a1d-8164-2fd34e9644f9

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: e1b57bb7-d49e-3dc3-8f1e-2a4f83519acc

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

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\": \"nam\",
    \"description\": \"Autem minima velit quia consequatur nihil deleniti rerum.\",
    \"company_location_uuid\": \"25d3de9b-1462-32d9-adf6-5468eaa8336c\",
    \"customer_uuid\": \"0f34907a-6ce1-3799-92de-79e22beae96b\",
    \"customer_address_uuid\": \"3503e3cc-0dd2-396b-98a0-fc3666b25b82\",
    \"status_uuid\": \"7cc8bc30-064f-3bec-8aad-42fbe421f2ac\",
    \"service_plan_uuids\": [
        \"autem\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"65bbf045-1b00-365e-97ad-2b588fdd985a\"
}"

$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' => 'nam',
            'description' => 'Autem minima velit quia consequatur nihil deleniti rerum.',
            'company_location_uuid' => '25d3de9b-1462-32d9-adf6-5468eaa8336c',
            'customer_uuid' => '0f34907a-6ce1-3799-92de-79e22beae96b',
            'customer_address_uuid' => '3503e3cc-0dd2-396b-98a0-fc3666b25b82',
            'status_uuid' => '7cc8bc30-064f-3bec-8aad-42fbe421f2ac',
            'service_plan_uuids' => [
                'autem',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => '65bbf045-1b00-365e-97ad-2b588fdd985a',
        ],
    ]
);
$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": "nam",
    "description": "Autem minima velit quia consequatur nihil deleniti rerum.",
    "company_location_uuid": "25d3de9b-1462-32d9-adf6-5468eaa8336c",
    "customer_uuid": "0f34907a-6ce1-3799-92de-79e22beae96b",
    "customer_address_uuid": "3503e3cc-0dd2-396b-98a0-fc3666b25b82",
    "status_uuid": "7cc8bc30-064f-3bec-8aad-42fbe421f2ac",
    "service_plan_uuids": [
        "autem"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "65bbf045-1b00-365e-97ad-2b588fdd985a"
};

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

description   string  optional  

The paragraph describing the proposal. Example: Autem minima velit quia consequatur nihil deleniti rerum.

company_location_uuid   string  optional  

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 25d3de9b-1462-32d9-adf6-5468eaa8336c

customer_uuid   string  optional  

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0f34907a-6ce1-3799-92de-79e22beae96b

customer_address_uuid   string  optional  

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 3503e3cc-0dd2-396b-98a0-fc3666b25b82

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 7cc8bc30-064f-3bec-8aad-42fbe421f2ac

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: 65bbf045-1b00-365e-97ad-2b588fdd985a

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\": \"2d7828f2-ff00-38d2-ab06-1c8164db027b\",
    \"customer_uuid\": \"9cd683de-1163-378b-af61-421817c9a85c\",
    \"customer_address_uuid\": \"dfd0ee06-1151-3f83-9fe6-33f34ea725ab\",
    \"status_uuid\": \"ceea0cce-1aea-333d-a21b-6f3b655aaa0e\",
    \"service_plan_uuids\": [
        \"quos\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"fcac14de-9982-3193-b777-40f002c3144f\",
    \"expire_at\": \"2025-09-30T05:15:15\"
}"

$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' => '2d7828f2-ff00-38d2-ab06-1c8164db027b',
            'customer_uuid' => '9cd683de-1163-378b-af61-421817c9a85c',
            'customer_address_uuid' => 'dfd0ee06-1151-3f83-9fe6-33f34ea725ab',
            'status_uuid' => 'ceea0cce-1aea-333d-a21b-6f3b655aaa0e',
            'service_plan_uuids' => [
                'quos',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => 'fcac14de-9982-3193-b777-40f002c3144f',
            'expire_at' => '2025-09-30T05:15:15',
        ],
    ]
);
$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": "2d7828f2-ff00-38d2-ab06-1c8164db027b",
    "customer_uuid": "9cd683de-1163-378b-af61-421817c9a85c",
    "customer_address_uuid": "dfd0ee06-1151-3f83-9fe6-33f34ea725ab",
    "status_uuid": "ceea0cce-1aea-333d-a21b-6f3b655aaa0e",
    "service_plan_uuids": [
        "quos"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "fcac14de-9982-3193-b777-40f002c3144f",
    "expire_at": "2025-09-30T05:15:15"
};

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: 2d7828f2-ff00-38d2-ab06-1c8164db027b

customer_uuid   string   

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 9cd683de-1163-378b-af61-421817c9a85c

customer_address_uuid   string   

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: dfd0ee06-1151-3f83-9fe6-33f34ea725ab

status_uuid   string   

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: ceea0cce-1aea-333d-a21b-6f3b655aaa0e

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: fcac14de-9982-3193-b777-40f002c3144f

include_fields   object  optional  
expire_at   string  optional  

Must be a valid date. Example: 2025-09-30T05:15:15

Update

requires authentication

Update a proposal activity entry

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/proposals/15/activity-logs/4cecf11b-d0ab-386f-9c8c-792582ff80a6" \
    --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/4cecf11b-d0ab-386f-9c8c-792582ff80a6';
$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/4cecf11b-d0ab-386f-9c8c-792582ff80a6"
);

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: 4cecf11b-d0ab-386f-9c8c-792582ff80a6

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\": \"Dolorem doloribus nisi error ut fuga.\",
    \"company_location_uuid\": \"0ad1da11-17ea-34ff-9f6b-40e5bc2e0199\",
    \"customer_uuid\": \"1c9bee81-8965-3283-a6d3-58860d506e67\",
    \"customer_address_uuid\": \"85f368c2-615d-313b-bc2c-94fefa9c9ad7\",
    \"status_uuid\": \"22bd0d1f-7765-3c32-b49b-1788973e16c4\",
    \"service_plan_uuids\": [
        \"nihil\"
    ],
    \"proposal_values\": [],
    \"proposal_template_uuid\": \"67920d2b-02d4-3f1b-9f08-52f1d8c56c0d\",
    \"expire_at\": \"2025-09-30T05:15:15\"
}"

$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' => 'Dolorem doloribus nisi error ut fuga.',
            'company_location_uuid' => '0ad1da11-17ea-34ff-9f6b-40e5bc2e0199',
            'customer_uuid' => '1c9bee81-8965-3283-a6d3-58860d506e67',
            'customer_address_uuid' => '85f368c2-615d-313b-bc2c-94fefa9c9ad7',
            'status_uuid' => '22bd0d1f-7765-3c32-b49b-1788973e16c4',
            'service_plan_uuids' => [
                'nihil',
            ],
            'proposal_values' => [],
            'proposal_template_uuid' => '67920d2b-02d4-3f1b-9f08-52f1d8c56c0d',
            'expire_at' => '2025-09-30T05:15:15',
        ],
    ]
);
$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": "Dolorem doloribus nisi error ut fuga.",
    "company_location_uuid": "0ad1da11-17ea-34ff-9f6b-40e5bc2e0199",
    "customer_uuid": "1c9bee81-8965-3283-a6d3-58860d506e67",
    "customer_address_uuid": "85f368c2-615d-313b-bc2c-94fefa9c9ad7",
    "status_uuid": "22bd0d1f-7765-3c32-b49b-1788973e16c4",
    "service_plan_uuids": [
        "nihil"
    ],
    "proposal_values": [],
    "proposal_template_uuid": "67920d2b-02d4-3f1b-9f08-52f1d8c56c0d",
    "expire_at": "2025-09-30T05:15:15"
};

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: Dolorem doloribus nisi error ut fuga.

company_location_uuid   string  optional  

The UUID of user's company location. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 0ad1da11-17ea-34ff-9f6b-40e5bc2e0199

customer_uuid   string  optional  

The UUID of customer you wish to send the proposal. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 1c9bee81-8965-3283-a6d3-58860d506e67

customer_address_uuid   string  optional  

The UUID of customer's address. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 85f368c2-615d-313b-bc2c-94fefa9c9ad7

status_uuid   string  optional  

The UUID of proposal status. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: 22bd0d1f-7765-3c32-b49b-1788973e16c4

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: 67920d2b-02d4-3f1b-9f08-52f1d8c56c0d

include_fields   object  optional  
expire_at   string  optional  

Must be a valid date. Example: 2025-09-30T05:15:15

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:\\/\\/ferry.org\\/\",
    \"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://ferry.org/',
            '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:\/\/ferry.org\/",
    "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://ferry.org/

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/7cb6663a-aa31-307b-958f-ed2d8ad64223" \
    --header "Authorization: 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/7cb6663a-aa31-307b-958f-ed2d8ad64223';
$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/7cb6663a-aa31-307b-958f-ed2d8ad64223"
);

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: 7cb6663a-aa31-307b-958f-ed2d8ad64223

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : title Example: voluptates

sort_order   string  optional  

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

search   string  optional  

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

filter_by_uuids   string  optional  

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

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\": \"exercitationem\",
    \"content\": \"deleniti\"
}"

$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' => 'exercitationem',
            'content' => 'deleniti',
        ],
    ]
);
$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": "exercitationem",
    "content": "deleniti"
};

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

content   string   

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

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\": \"error\",
    \"content\": \"voluptatem\"
}"

$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' => 'error',
            'content' => 'voluptatem',
        ],
    ]
);
$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": "error",
    "content": "voluptatem"
};

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

content   string   

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

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\": \"earum\",
    \"content\": \"eum\"
}"

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

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

content   string  optional  

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

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\": \"qui\",
    \"content\": \"dolorem\"
}"

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

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

content   string  optional  

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

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/aut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/update-limit/aut';
$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/aut"
);

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

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

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

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:\\/\\/gusikowski.org\\/\",
    \"google_my_business_listing\": \"http:\\/\\/cronin.org\\/non-et-occaecati-sequi-voluptatum-dicta\",
    \"image_url\": \"http:\\/\\/witting.com\\/a-et-error-aut-eos\",
    \"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://gusikowski.org/',
            'google_my_business_listing' => 'http://cronin.org/non-et-occaecati-sequi-voluptatum-dicta',
            'image_url' => 'http://witting.com/a-et-error-aut-eos',
            '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:\/\/gusikowski.org\/",
    "google_my_business_listing": "http:\/\/cronin.org\/non-et-occaecati-sequi-voluptatum-dicta",
    "image_url": "http:\/\/witting.com\/a-et-error-aut-eos",
    "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://gusikowski.org/

google_my_business_listing   string  optional  

Must be a valid URL. Example: http://cronin.org/non-et-occaecati-sequi-voluptatum-dicta

image_url   string  optional  

Example: http://witting.com/a-et-error-aut-eos

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\": \"est\"
}"

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

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

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\": \"nesciunt\",
    \"address2\": \"aut\",
    \"city\": \"aut\",
    \"country_state_uuid\": \"5f872406-bdb7-3b22-9ab6-7eabb5082d96\",
    \"country_uuid\": \"ac3faaeb-df7a-353a-b5fa-7bafc9b6824f\",
    \"postal_code\": \"non\",
    \"latitude\": \"ut\",
    \"longitude\": \"aperiam\",
    \"is_primary\": \"rerum\",
    \"settings\": \"est\",
    \"county\": \"repellat\"
}"

$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' => 'nesciunt',
            'address2' => 'aut',
            'city' => 'aut',
            'country_state_uuid' => '5f872406-bdb7-3b22-9ab6-7eabb5082d96',
            'country_uuid' => 'ac3faaeb-df7a-353a-b5fa-7bafc9b6824f',
            'postal_code' => 'non',
            'latitude' => 'ut',
            'longitude' => 'aperiam',
            'is_primary' => 'rerum',
            'settings' => 'est',
            'county' => 'repellat',
        ],
    ]
);
$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": "nesciunt",
    "address2": "aut",
    "city": "aut",
    "country_state_uuid": "5f872406-bdb7-3b22-9ab6-7eabb5082d96",
    "country_uuid": "ac3faaeb-df7a-353a-b5fa-7bafc9b6824f",
    "postal_code": "non",
    "latitude": "ut",
    "longitude": "aperiam",
    "is_primary": "rerum",
    "settings": "est",
    "county": "repellat"
};

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

address2   string  optional  

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

city   string  optional  

optional The city. Example : Queen Creek Example: aut

country_state_uuid   string  optional  

optional The state uuid. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: 5f872406-bdb7-3b22-9ab6-7eabb5082d96

country_uuid   string  optional  

optional The country uuid. Example : 3245d630-24fd-11ec-accd-e397aec85c7f Example: ac3faaeb-df7a-353a-b5fa-7bafc9b6824f

postal_code   string  optional  

optional The postal code. Example : 12345 Example: non

latitude   string  optional  

optional The latitude. Example : 33.2486 Example: ut

longitude   string  optional  

optional The longitude. Example : 111.6377 Example: aperiam

is_primary   string  optional  

optional The is_primary. Example : true Example: rerum

settings   string  optional  

optional The settings. Example : {} Example: est

county   string  optional  

optional The county. Example : Pinal County Example: repellat

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

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

sort_order   string  optional  

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

search   string  optional  

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

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/b7856839-6d6c-361e-b6fa-39e68879aee4" \
    --header "Authorization: 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/b7856839-6d6c-361e-b6fa-39e68879aee4';
$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/b7856839-6d6c-361e-b6fa-39e68879aee4"
);

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: b7856839-6d6c-361e-b6fa-39e68879aee4

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/7eff0bf0-b0c7-3324-94b4-893e1bbbcea9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"pricing_group\": [],
    \"save_service_plan_as\": \"SERVICE_PLAN_ARCHIVED\",
    \"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/7eff0bf0-b0c7-3324-94b4-893e1bbbcea9';
$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_ARCHIVED',
            '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/7eff0bf0-b0c7-3324-94b4-893e1bbbcea9"
);

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

let body = {
    "pricing_group": [],
    "save_service_plan_as": "SERVICE_PLAN_ARCHIVED",
    "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: 7eff0bf0-b0c7-3324-94b4-893e1bbbcea9

Body Parameters

pricing_group   object   
pricing_group_rules   object  optional  
save_service_plan_as   string  optional  

Example: SERVICE_PLAN_ARCHIVED

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/ae274ea8-0de8-3f70-a257-253b55c8df8e" \
    --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/ae274ea8-0de8-3f70-a257-253b55c8df8e';
$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/ae274ea8-0de8-3f70-a257-253b55c8df8e"
);

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: ae274ea8-0de8-3f70-a257-253b55c8df8e

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/c52f465e-3557-325f-a9a4-14b297dcfd47" \
    --header "Authorization: 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/c52f465e-3557-325f-a9a4-14b297dcfd47';
$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/c52f465e-3557-325f-a9a4-14b297dcfd47"
);

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: c52f465e-3557-325f-a9a4-14b297dcfd47

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : title Example: reprehenderit

sort_order   string  optional  

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

search   string  optional  

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

filter_by_uuids   string  optional  

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

groups   string  optional  

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

report_type   string  optional  

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

template   string  optional  

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

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: 41655afa-a430-3f21-bb8a-7328e6462a82

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

company_location_uuid   string  optional  

optional string The company location uuid. Example : "815d3d9c-f371-3781-8456-7e6954b5b0f5" Example: ac53233a-f1ab-3afc-b2ce-4ce20a912935

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\": [
        \"perferendis\"
    ],
    \"import_files\": \"perspiciatis\",
    \"override\": false,
    \"admin_only\": false
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/import-defaults';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'tags' => [
                'perferendis',
            ],
            'import_files' => 'perspiciatis',
            'override' => false,
            'admin_only' => false,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults"
);

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

let body = {
    "tags": [
        "perferendis"
    ],
    "import_files": "perspiciatis",
    "override": false,
    "admin_only": false
};

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

Request      

POST api/v1/companies/{company_uuid}/import-defaults

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: perspiciatis

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: false

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: false

Apply Import Set to Company

requires authentication

Store a newly created import set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults/upload" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tags\": [
        \"maxime\"
    ],
    \"import_files\": \"omnis\",
    \"override\": false,
    \"admin_only\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/companies/1/import-defaults/upload';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'tags' => [
                'maxime',
            ],
            'import_files' => 'omnis',
            'override' => false,
            'admin_only' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
const url = new URL(
    "https://api.smarterlaunch.com/api/v1/companies/1/import-defaults/upload"
);

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

let body = {
    "tags": [
        "maxime"
    ],
    "import_files": "omnis",
    "override": false,
    "admin_only": true
};

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

Request      

POST api/v1/companies/{company_uuid}/import-defaults/upload

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: omnis

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: false

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: true

List

requires authentication

Shows the list of import set with pagination.

Example request:
curl --request GET \
    --get "https://api.smarterlaunch.com/api/v1/import-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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

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

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

Request      

GET api/v1/import-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

page   integer  optional  

The page number. Example : 1 Example: 1

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

sort_order   string  optional  

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

search   string  optional  

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

type_name   string  optional  

Filter by import type name : "Categories" Example: ducimus

type_code   string  optional  

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

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\": [
        \"qui\"
    ],
    \"import_files\": \"est\",
    \"override\": true,
    \"admin_only\": true
}"

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

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

let body = {
    "tags": [
        "qui"
    ],
    "import_files": "est",
    "override": true,
    "admin_only": true
};

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

Request      

POST api/v1/import-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

tags   string[]   

The array of tags to be associated in an import set. Example : ["Pest Control", "Arizona"]

import_files   files   

The set of json files containing import settings data. Example: est

override   boolean   

Determine if the import set will replace the current ones with matchinig names. Example : false Example: true

admin_only   boolean   

Determine if the import set is only accessible by admin. Example : true Example: true

Update

requires authentication

Update a import set.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/import-sets/23" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"import_files\": \"repudiandae\",
    \"admin_only\": true,
    \"is_selected\": true
}"

$client = new \GuzzleHttp\Client();
$url = 'https://api.smarterlaunch.com/api/v1/import-sets/23';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'import_files' => 'repudiandae',
            '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 = {
    "import_files": "repudiandae",
    "admin_only": true,
    "is_selected": true
};

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

Request      

PUT api/v1/import-sets/{importSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

importSet_uuid   integer   

Example: 23

Body Parameters

import_files   files   

The set of json files containing import settings data. Example: repudiandae

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

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

sort_by   string  optional  

The column name. Example : name Example: et

sort_order   string  optional  

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

search   string  optional  

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

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\": [
        \"maxime\"
    ],
    \"import_files\": \"ipsa\",
    \"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' => [
                'maxime',
            ],
            'import_files' => 'ipsa',
            '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": [
        "maxime"
    ],
    "import_files": "ipsa",
    "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: ipsa

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

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

sort_order   string  optional  

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

search   string  optional  

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

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\": \"perferendis\",
    \"assignment\": \"voluptatem\",
    \"form_fields\": [
        \"soluta\"
    ]
}"

$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' => 'perferendis',
            'assignment' => 'voluptatem',
            'form_fields' => [
                'soluta',
            ],
        ],
    ]
);
$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": "perferendis",
    "assignment": "voluptatem",
    "form_fields": [
        "soluta"
    ]
};

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

assignment   string   

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

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

input_type   string  optional  

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

default_value   string  optional  

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

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

position   integer  optional  

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

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\": \"officiis\",
    \"assignment\": \"non\",
    \"form_fields\": [
        \"eum\"
    ]
}"

$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' => 'officiis',
            'assignment' => 'non',
            'form_fields' => [
                'eum',
            ],
        ],
    ]
);
$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": "officiis",
    "assignment": "non",
    "form_fields": [
        "eum"
    ]
};

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

assignment   string   

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

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

input_type   string  optional  

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

default_value   string  optional  

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

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

position   integer  optional  

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

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\": \"asperiores\",
    \"assignment\": \"nulla\",
    \"form_fields\": [
        \"fugit\"
    ]
}"

$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' => 'asperiores',
            'assignment' => 'nulla',
            'form_fields' => [
                'fugit',
            ],
        ],
    ]
);
$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": "asperiores",
    "assignment": "nulla",
    "form_fields": [
        "fugit"
    ]
};

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

assignment   string   

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

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

input_type   string  optional  

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

default_value   string  optional  

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

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

position   integer  optional  

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

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\": \"consequatur\",
    \"assignment\": \"numquam\",
    \"form_fields\": [
        \"saepe\"
    ]
}"

$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' => 'consequatur',
            'assignment' => 'numquam',
            'form_fields' => [
                'saepe',
            ],
        ],
    ]
);
$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": "consequatur",
    "assignment": "numquam",
    "form_fields": [
        "saepe"
    ]
};

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

assignment   string  optional  

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

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

input_type   string  optional  

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

default_value   string  optional  

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

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

position   integer  optional  

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

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

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

sort_order   string  optional  

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

search   string  optional  

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

exclude   string  optional  

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

Show

requires authentication

Show a single description set.

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

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

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

Request      

GET api/v1/companies/{company_uuid}/description-sets/{descriptionSet_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

descriptionSet_uuid   integer   

Example: 1

Store

requires authentication

Store a newly created description set.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"options\": [
        \"eaque\"
    ]
}"

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

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

let body = {
    "name": "et",
    "options": [
        "eaque"
    ]
};

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

Request      

POST api/v1/companies/{company_uuid}/description-sets

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the description set. Example : "Termite" Example: et

options   string[]   

The options of the description set. Example : [{"title":"Termite","description":["description 1","description 2"]}]

Update

requires authentication

Update a description set.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/companies/1/description-sets/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"options\": [
        \"id\"
    ]
}"

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

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

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\": \"accusamus\",
    \"options\": [
        \"tenetur\"
    ]
}"

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

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

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

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

sort_order   string  optional  

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

search   string  optional  

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

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

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

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

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

page_size   integer  optional  

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

sort_by   string  optional  

The column name. Example : name Example: voluptatem

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

filter_by_solution_category_uuids   string  optional  

array To filter the list of solutions by solution category. Example : ["3c787d66-2a4f-3f1d-9591-c330be0abe82"] Example: natus

filter_by_status_uuid   string  optional  

To filter the list the status. Example : "3c787d66-2a4f-3f1d-9591-c330be0abe82" Example: 47c33d32-a16a-3e3f-ae01-5c92fdd39f3e

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\": \"1eadaff8-f2f1-3ba3-8216-d06751ffc0e1\",
    \"name\": \"pariatur\",
    \"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' => '1eadaff8-f2f1-3ba3-8216-d06751ffc0e1',
            'name' => 'pariatur',
            '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": "1eadaff8-f2f1-3ba3-8216-d06751ffc0e1",
    "name": "pariatur",
    "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: 1eadaff8-f2f1-3ba3-8216-d06751ffc0e1

name   string   

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

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

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\": \"4b785b1c-85be-36f4-8896-ce5e8979a7db\",
    \"name\": \"quia\",
    \"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' => '4b785b1c-85be-36f4-8896-ce5e8979a7db',
            'name' => 'quia',
            '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": "4b785b1c-85be-36f4-8896-ce5e8979a7db",
    "name": "quia",
    "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: 4b785b1c-85be-36f4-8896-ce5e8979a7db

name   string   

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

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

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\": \"c4960d24-ba78-309d-940a-16e0ecd2149f\",
    \"name\": \"tenetur\",
    \"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' => 'c4960d24-ba78-309d-940a-16e0ecd2149f',
            'name' => 'tenetur',
            '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": "c4960d24-ba78-309d-940a-16e0ecd2149f",
    "name": "tenetur",
    "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: c4960d24-ba78-309d-940a-16e0ecd2149f

name   string  optional  

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

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\": [
        \"eum\"
    ],
    \"customer_address\": [
        \"earum\"
    ]
}"

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

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\": [
        \"non\"
    ],
    \"customer_address\": [
        \"nisi\"
    ]
}"

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

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

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

category_group   string  optional  

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

Create

requires authentication

Store a newly created Category.

Example request:
curl --request POST \
    "https://api.smarterlaunch.com/api/v1/categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"category_group\": \"SERVICE_PLAN\"
}"

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

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

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "category_group": "SERVICE_PLAN"
};

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

Request      

POST api/v1/categories

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

Body Parameters

name   string   

The name of the category. Example: Small Pests

description   string  optional  

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

category_group   string   

The category_group of the category. ['SERVICE_PLAN']. Example: SERVICE_PLAN

Get

requires authentication

Display the specified Category.

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

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

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

Request      

GET api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Update

requires authentication

Modify the specified Category.

Example request:
curl --request PUT \
    "https://api.smarterlaunch.com/api/v1/categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"category_group\": \"DRAWING_SYMBOL\"
}"

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

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

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "category_group": "DRAWING_SYMBOL"
};

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

Request      

PUT api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Body Parameters

name   string   

The name of the category. Example: Small Pests

description   string  optional  

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

category_group   string  optional  

Example: DRAWING_SYMBOL

Must be one of:
  • SERVICE_PLAN
  • DRAWING_SYMBOL

Patch

requires authentication

Perform patches for the specified Category.

Example request:
curl --request PATCH \
    "https://api.smarterlaunch.com/api/v1/categories/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Small Pests\",
    \"description\": \"Lorem ipsum dolor sit amet consectetur adipisicing elit\",
    \"category_group\": \"SERVICE_PLAN\"
}"

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

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

let body = {
    "name": "Small Pests",
    "description": "Lorem ipsum dolor sit amet consectetur adipisicing elit",
    "category_group": "SERVICE_PLAN"
};

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

Request      

PATCH api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Body Parameters

name   string  optional  

The name of the category. Example: Small Pests

description   string  optional  

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

category_group   string  optional  

Example: SERVICE_PLAN

Must be one of:
  • SERVICE_PLAN
  • DRAWING_SYMBOL

Delete

requires authentication

Remove the specified Category.

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

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

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

Request      

DELETE api/v1/categories/{category_uuid}

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

category_uuid   integer   

Example: 1

Schedule

API for Schedule

List

requires authentication

Shows the list of schedule with pagination.

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

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

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

Request      

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

Headers

Authorization      

Example: Bearer {YOUR_AUTH_KEY}

Content-Type      

Example: application/json

Accept      

Example: application/json

URL Parameters

company_uuid   integer   

Example: 1

page   integer  optional  

The page number. Example : 1 Example: 20

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

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

type   string  optional  

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

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\": \"maxime\",
    \"description\": \"Officiis porro nam suscipit ut odit similique voluptas.\",
    \"type\": \"vel\",
    \"units\": 2,
    \"term\": \"error\",
    \"enabled_service_months\": [
        \"molestiae\"
    ],
    \"visits\": 20
}"

$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' => 'maxime',
            'description' => 'Officiis porro nam suscipit ut odit similique voluptas.',
            'type' => 'vel',
            'units' => 2,
            'term' => 'error',
            'enabled_service_months' => [
                'molestiae',
            ],
            'visits' => 20,
        ],
    ]
);
$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": "maxime",
    "description": "Officiis porro nam suscipit ut odit similique voluptas.",
    "type": "vel",
    "units": 2,
    "term": "error",
    "enabled_service_months": [
        "molestiae"
    ],
    "visits": 20
};

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

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Officiis porro nam suscipit ut odit similique voluptas.

type   string   

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

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

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

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\": \"est\",
    \"description\": \"Expedita beatae consequatur dolor quos maiores neque.\",
    \"type\": \"nesciunt\",
    \"units\": 20,
    \"term\": \"aut\",
    \"enabled_service_months\": [
        \"laboriosam\"
    ],
    \"visits\": 3
}"

$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' => 'est',
            'description' => 'Expedita beatae consequatur dolor quos maiores neque.',
            'type' => 'nesciunt',
            'units' => 20,
            'term' => 'aut',
            'enabled_service_months' => [
                'laboriosam',
            ],
            '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": "est",
    "description": "Expedita beatae consequatur dolor quos maiores neque.",
    "type": "nesciunt",
    "units": 20,
    "term": "aut",
    "enabled_service_months": [
        "laboriosam"
    ],
    "visits": 3
};

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

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Expedita beatae consequatur dolor quos maiores neque.

type   string   

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

units   integer   

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

term   string   

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

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

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\": \"omnis\",
    \"description\": \"Quidem ea facere tempore enim ducimus.\",
    \"type\": \"necessitatibus\",
    \"units\": 15,
    \"term\": \"recusandae\",
    \"enabled_service_months\": [
        \"dolores\"
    ],
    \"visits\": 18
}"

$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' => 'omnis',
            'description' => 'Quidem ea facere tempore enim ducimus.',
            'type' => 'necessitatibus',
            'units' => 15,
            'term' => 'recusandae',
            'enabled_service_months' => [
                'dolores',
            ],
            'visits' => 18,
        ],
    ]
);
$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": "omnis",
    "description": "Quidem ea facere tempore enim ducimus.",
    "type": "necessitatibus",
    "units": 15,
    "term": "recusandae",
    "enabled_service_months": [
        "dolores"
    ],
    "visits": 18
};

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

description   string  optional  

The description of the schedule. Example : "Lorem ipsum dolor sit, amet consectetur adipisicing elit. Consequatur dolores iste quae soluta." Example: Quidem ea facere tempore enim ducimus.

type   string   

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

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

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

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