Introduction
API documentation for developers
This documentation aims to provide all the information you need to work with the Smarter Launch API.
Rate Limiting
The API implements rate limiting to ensure fair usage and system stability. Different endpoint groups have different rate limits:
- Authentication endpoints (login, register, password reset): 15 requests per minute
- File upload endpoints: 50 requests per minute
- Public/unauthenticated endpoints: 75 requests per minute
- Authenticated endpoints (most API operations): 200 requests per minute
- Webhook endpoints: 300 requests per minute
When you exceed the rate limit, the API will return a 429 Too Many Requests response. Rate limit information is included in the response headers:
X-RateLimit-Limit: Maximum number of requests allowed in the time windowX-RateLimit-Remaining: Number of requests remaining in the current time windowRetry-After: Number of seconds to wait before making another request (included in 429 responses)
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.
App Data
Retrieve system reference data including countries, states, user roles, record statuses, industries, property locations, and other enumerated values needed for application functionality.
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://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Automations
Create workflow automations with triggers, filters, and actions to automate business processes. Automations can be enabled/disabled and configured to run during specific business hours.
List
requires authentication
Shows the list of Automations with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations?page=2&page_size=1&sort_by=qui&sort_order=omnis&search=neque" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '2',
'page_size' => '1',
'sort_by' => 'qui',
'sort_order' => 'omnis',
'search' => 'neque',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations"
);
const params = {
"page": "2",
"page_size": "1",
"sort_by": "qui",
"sort_order": "omnis",
"search": "neque",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Store a newly created Automation.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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\": [
\"beatae\"
],
\"filters\": [
\"est\"
],
\"triggers\": [
\"et\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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' => [
'beatae',
],
'filters' => [
'est',
],
'triggers' => [
'et',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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": [
"beatae"
],
"filters": [
"est"
],
"triggers": [
"et"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get
requires authentication
Display the specified Automation.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/1/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Modify the specified Automation.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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\": [
\"omnis\"
],
\"filters\": [
\"maxime\"
],
\"triggers\": [
\"vero\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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' => [
'omnis',
],
'filters' => [
'maxime',
],
'triggers' => [
'vero',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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": [
"omnis"
],
"filters": [
"maxime"
],
"triggers": [
"vero"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Perform patches for the specified Automation.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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\": [
\"voluptatem\"
],
\"filters\": [
\"unde\"
],
\"triggers\": [
\"quia\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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' => [
'voluptatem',
],
'filters' => [
'unde',
],
'triggers' => [
'quia',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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": [
"voluptatem"
],
"filters": [
"unde"
],
"triggers": [
"quia"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Remove the specified Automation.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/automations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Categories
Organize service plans and drawing symbols into categories (e.g., Rodent Control, Termite Treatment). Categories help structure service offerings and diagram symbols for better organization.
List
requires authentication
Shows the list of Categories with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/categories?page=6&page_size=17&sort_by=voluptates&sort_order=mollitia&search=eum&category_group=SERVICE_PLAN" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/categories';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '6',
'page_size' => '17',
'sort_by' => 'voluptates',
'sort_order' => 'mollitia',
'search' => 'eum',
'category_group' => 'SERVICE_PLAN',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/categories"
);
const params = {
"page": "6",
"page_size": "17",
"sort_by": "voluptates",
"sort_order": "mollitia",
"search": "eum",
"category_group": "SERVICE_PLAN",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Store a newly created Category.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get
requires authentication
Display the specified Category.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Modify the specified Category.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Perform patches for the specified Category.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Remove the specified Category.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company
Manage your company profile including business name, logo, contact information, branding settings, billing configuration, and company-wide preferences.
List / Fetch.
requires authentication
Shows the list of company or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store company logo.
requires authentication
This endpoint lets company to upload or update their logo.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/image" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "image_url=@/tmp/phpBrBqXK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpBrBqXK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Company
requires authentication
This endpoint lets user to update a company.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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:\\/\\/emard.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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://emard.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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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:\/\/emard.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch Company
requires authentication
This endpoint lets user to update a company.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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\": \"https:\\/\\/hagenes.com\\/sint-expedita-voluptas-fuga-beatae-at.html\",
\"google_my_business_listing\": \"http:\\/\\/bartell.com\\/nulla-id-et-nisi\",
\"image_url\": \"http:\\/\\/www.weimann.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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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' => 'https://hagenes.com/sint-expedita-voluptas-fuga-beatae-at.html',
'google_my_business_listing' => 'http://bartell.com/nulla-id-et-nisi',
'image_url' => 'http://www.weimann.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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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": "https:\/\/hagenes.com\/sint-expedita-voluptas-fuga-beatae-at.html",
"google_my_business_listing": "http:\/\/bartell.com\/nulla-id-et-nisi",
"image_url": "http:\/\/www.weimann.com\/",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove company logo.
requires authentication
Only self can remove his logo.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/logo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/logo';
$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://staging.api.smarterlaunch.com/api/v1/companies/logo"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Redirect to Stripe Billing Auth
requires authentication
This endpoint lets user to redirect to Stripe Billing Auth.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/billing"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get settings JSON file URL
requires authentication
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/settings-json" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"settings_name\": \"repellendus\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/settings-json';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'settings_name' => 'repellendus',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/settings-json"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"settings_name": "repellendus"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST Upload Base64 files to S3
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.PATCH api/v1/companies/{company_uuid}/update-limit/{entity}
requires authentication
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/update-limit/{entity}" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/update-limit/{entity}';
$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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/update-limit/{entity}"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company Users
Invite and manage company users with location assignments. Handle user invitations, activation, role assignment, team membership, and company-specific user settings.
List
requires authentication
Shows the list of company users that the user has access to view.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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\": true,
\"page_size\": 15,
\"sort_by\": \"display_name\",
\"sort_order\": \"asc\",
\"search\": \"John\",
\"filter_by_status_code\": \"STATUS_ACTIVE \\/ [\\\"STATUS_ACTIVE\\\".\\\"STATUS_DISABLED\\\"]\",
\"filter_by_role_code\": \"ROLE_COMPANY_MANAGER\",
\"filter_by_company_location_uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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' => true,
'page_size' => 15,
'sort_by' => 'display_name',
'sort_order' => 'asc',
'search' => 'John',
'filter_by_status_code' => 'STATUS_ACTIVE / ["STATUS_ACTIVE"."STATUS_DISABLED"]',
'filter_by_role_code' => 'ROLE_COMPANY_MANAGER',
'filter_by_company_location_uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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": true,
"page_size": 15,
"sort_by": "display_name",
"sort_order": "asc",
"search": "John",
"filter_by_status_code": "STATUS_ACTIVE \/ [\"STATUS_ACTIVE\".\"STATUS_DISABLED\"]",
"filter_by_role_code": "ROLE_COMPANY_MANAGER",
"filter_by_company_location_uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Shows detail of a specific company user
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/users/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/users/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/users/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Send invitation to user.
requires authentication
This endpoint lets company owner to send invite to its sub-user.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/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\": [],
\"position\": \"l\",
\"phone\": \"ybstkcqcbwawj\",
\"last_name\": \"Smith\",
\"company_locations[]\": \"[\\\"45955590-4152-11ec-9c77-2181a8ee04db\\\"]\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/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' => [],
'position' => 'l',
'phone' => 'ybstkcqcbwawj',
'last_name' => 'Smith',
'company_locations[]' => '["45955590-4152-11ec-9c77-2181a8ee04db"]',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/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": [],
"position": "l",
"phone": "ybstkcqcbwawj",
"last_name": "Smith",
"company_locations[]": "[\"45955590-4152-11ec-9c77-2181a8ee04db\"]"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Resend invitation to user.
requires authentication
This endpoint lets company owner to send invite to its sub-user.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Force activate user
requires authentication
This endpoint lets admin/super admin to activate user.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/1/users/1/activate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/1/users/1/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://staging.api.smarterlaunch.com/api/v1/companies/1/users/1/activate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
This endpoint lets the user update company user.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/users/{userUuid}" \
--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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/users/{userUuid}';
$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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/users/{userUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
This endpoint lets the user patch company user.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/users/{userUuid}" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"John\",
\"last_name\": \"Smith\",
\"role_uuid\": \"45955590-4152-11ec-9c77-2181a8ee04db\",
\"company_locations\": [
\"3245d630-24fd-11ec-accd-e397aec85c7f\"
],
\"status_uuid\": \"2d4e8dbc-71a5-3f4c-81e3-1db2aaf7997c\",
\"email\": \"hello@smarterlaunch.com\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/users/{userUuid}';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'first_name' => 'John',
'last_name' => 'Smith',
'role_uuid' => '45955590-4152-11ec-9c77-2181a8ee04db',
'company_locations' => [
'3245d630-24fd-11ec-accd-e397aec85c7f',
],
'status_uuid' => '2d4e8dbc-71a5-3f4c-81e3-1db2aaf7997c',
'email' => 'hello@smarterlaunch.com',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/users/{userUuid}"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"first_name": "John",
"last_name": "Smith",
"role_uuid": "45955590-4152-11ec-9c77-2181a8ee04db",
"company_locations": [
"3245d630-24fd-11ec-accd-e397aec85c7f"
],
"status_uuid": "2d4e8dbc-71a5-3f4c-81e3-1db2aaf7997c",
"email": "hello@smarterlaunch.com"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
This endpoint allows owner to delete a user.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Countries
Retrieve available countries and states/provinces for address forms and geographic data. Used in customer and company location configuration.
List / Fetch
Shows the list of country or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List / Fetch
Shows the list of country or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/countries/{countryUuid}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\",
\"name\": \"baroda\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/countries/{countryUuid}';
$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://staging.api.smarterlaunch.com/api/v1/countries/{countryUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get country states using country uuid.
Shows the list of states using country uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/countries/1/states" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/countries/1/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://staging.api.smarterlaunch.com/api/v1/countries/1/states"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customer Addresses
Manage service addresses for customers. A single customer may have multiple properties requiring pest control services at different locations.
Update
requires authentication
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch Customer Address
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/customer-addresses/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"address1\": \"reiciendis\",
\"address2\": \"ea\",
\"city\": \"qui\",
\"country_state_uuid\": \"6c8f24b1-3aae-3816-af80-5ca543447492\",
\"country_uuid\": \"bc3ac834-2742-31db-badc-bd5f2622a927\",
\"postal_code\": \"repudiandae\",
\"latitude\": \"porro\",
\"longitude\": \"unde\",
\"is_primary\": \"ipsam\",
\"settings\": \"commodi\",
\"county\": \"suscipit\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/customer-addresses/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'address1' => 'reiciendis',
'address2' => 'ea',
'city' => 'qui',
'country_state_uuid' => '6c8f24b1-3aae-3816-af80-5ca543447492',
'country_uuid' => 'bc3ac834-2742-31db-badc-bd5f2622a927',
'postal_code' => 'repudiandae',
'latitude' => 'porro',
'longitude' => 'unde',
'is_primary' => 'ipsam',
'settings' => 'commodi',
'county' => 'suscipit',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/customer-addresses/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"address1": "reiciendis",
"address2": "ea",
"city": "qui",
"country_state_uuid": "6c8f24b1-3aae-3816-af80-5ca543447492",
"country_uuid": "bc3ac834-2742-31db-badc-bd5f2622a927",
"postal_code": "repudiandae",
"latitude": "porro",
"longitude": "unde",
"is_primary": "ipsam",
"settings": "commodi",
"county": "suscipit"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Integration Data
requires authentication
Get data from a 3rd party API
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/customer-addresses/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/customer-addresses/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/customer-addresses/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customer Contacts
Manage additional contact persons for customer accounts. Store phone numbers, emails, and contact preferences for multiple decision-makers at a property.
Update
requires authentication
Update customer contacts
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Customers
Manage customer records including contact information, service addresses (multiple addresses per customer), billing details, referral source tracking, status, custom field data, and CRM integration metadata.
List
requires authentication
Shows the list of company customers that the user has access to view.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
This endpoint returns detail of a certain customer.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Create a new customer along with their primary contact and address
Example request:
curl --request POST \
"https://staging.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\": [
\"tempora\"
],
\"customer_address\": [
\"voluptatem\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => [
'tempora',
],
'customer_address' => [
'voluptatem',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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": [
"tempora"
],
"customer_address": [
"voluptatem"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update with contact and address
requires authentication
This is to update those partial customer data
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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\": [
\"natus\"
],
\"customer_address\": [
\"et\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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' => [
'natus',
],
'customer_address' => [
'et',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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": [
"natus"
],
"customer_address": [
"et"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update individual customer account name and the location they are associated with.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch individual customer account name and the location they are associated with.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
This end point allows user the delete the customer.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/customers/{customer_uuid}" \
--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://staging.api.smarterlaunch.com/api/v1/customers/{customer_uuid}';
$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://staging.api.smarterlaunch.com/api/v1/customers/{customer_uuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Sync
requires authentication
This endpoint allows user to perform manual sync to a customer
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/sync" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/customers/3fa85f64-5717-4562-b3fc-2c963f66afa6/sync"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Decline Reasons
Track reasons why customers decline proposals (price too high, went with competitor, not interested, etc.). Analyze decline data to improve sales processes and understand common objections.
List
requires authentication
Shows the list of decline reasons with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons?page=4&page_size=15&sort_by=quibusdam&sort_order=culpa&search=iusto" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '4',
'page_size' => '15',
'sort_by' => 'quibusdam',
'sort_order' => 'culpa',
'search' => 'iusto',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons"
);
const params = {
"page": "4",
"page_size": "15",
"sort_by": "quibusdam",
"sort_order": "culpa",
"search": "iusto",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single decline reason.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created decline reasons.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"voluptatem\",
\"description\": \"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'voluptatem',
'description' => 'Lorem, ipsum dolor sit amet consectetur adipisicing elit.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "voluptatem",
"description": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a decline reason.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"alias\",
\"description\": \"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'alias',
'description' => 'Lorem, ipsum dolor sit amet consectetur adipisicing elit.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "alias",
"description": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company decline reason.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"assumenda\",
\"description\": \"Lorem, ipsum dolor sit amet consectetur adipisicing elit.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'assumenda',
'description' => 'Lorem, ipsum dolor sit amet consectetur adipisicing elit.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "assumenda",
"description": "Lorem, ipsum dolor sit amet consectetur adipisicing elit."
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a decline reason.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline-reasons/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Description Sets
Create reusable description templates for services, proposals, and documents. Maintain consistent professional messaging across your sales and service materials.
List
requires authentication
Shows the list of description set with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets?page=2&page_size=10&sort_by=est&sort_order=molestiae&search=qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '2',
'page_size' => '10',
'sort_by' => 'est',
'sort_order' => 'molestiae',
'search' => 'qui',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets"
);
const params = {
"page": "2",
"page_size": "10",
"sort_by": "est",
"sort_order": "molestiae",
"search": "qui",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single description set.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created description set.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"fugiat\",
\"options\": [
\"fuga\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'fugiat',
'options' => [
'fuga',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "fugiat",
"options": [
"fuga"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a description set.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"reprehenderit\",
\"options\": [
\"quia\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'reprehenderit',
'options' => [
'quia',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "reprehenderit",
"options": [
"quia"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company description set.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"molestiae\",
\"options\": [
\"quasi\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'molestiae',
'options' => [
'quasi',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "molestiae",
"options": [
"quasi"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a description set.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/description-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Field Groups
Create groups of custom fields to collect additional business-specific information on customers, proposals, or other records. Organize custom data collection into logical field sets.
List
requires authentication
Shows the list of company custom field groups with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups?page=16&page_size=10&sort_by=repellendus&sort_order=ad&search=molestiae" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '16',
'page_size' => '10',
'sort_by' => 'repellendus',
'sort_order' => 'ad',
'search' => 'molestiae',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups"
);
const params = {
"page": "16",
"page_size": "10",
"sort_by": "repellendus",
"sort_order": "ad",
"search": "molestiae",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single company custom field group.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created company custom field group.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"qui\",
\"assignment\": \"iure\",
\"company_custom_fields\": [
\"consequatur\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'qui',
'assignment' => 'iure',
'company_custom_fields' => [
'consequatur',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "qui",
"assignment": "iure",
"company_custom_fields": [
"consequatur"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a company custom field group.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"a\",
\"assignment\": \"quaerat\",
\"company_custom_fields\": [
\"architecto\"
],
\"deleted_custom_field_uuids\": [
\"libero\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'a',
'assignment' => 'quaerat',
'company_custom_fields' => [
'architecto',
],
'deleted_custom_field_uuids' => [
'libero',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "a",
"assignment": "quaerat",
"company_custom_fields": [
"architecto"
],
"deleted_custom_field_uuids": [
"libero"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company custom field group.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"et\",
\"assignment\": \"doloribus\",
\"company_custom_fields\": [
\"tempora\"
],
\"deleted_custom_field_uuids\": [
\"deleniti\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'et',
'assignment' => 'doloribus',
'company_custom_fields' => [
'tempora',
],
'deleted_custom_field_uuids' => [
'deleniti',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "et",
"assignment": "doloribus",
"company_custom_fields": [
"tempora"
],
"deleted_custom_field_uuids": [
"deleniti"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a company custom field group.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-field-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.File Upload
Generate pre-signed URLs for secure direct-to-S3 file uploads. Upload photos, documents, PDFs, and media without passing files through the API server.
POST Get S3 Pre-signed Url for Proposal Review
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST Get S3 Pre-signed Url
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST Get S3 Pre-signed Url
requires authentication
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.POST api/v1/upload-from-url
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/upload-from-url" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"url\": \"http:\\/\\/www.wyman.com\\/excepturi-ducimus-tempore-dicta-aliquid-est\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/upload-from-url';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'url' => 'http://www.wyman.com/excepturi-ducimus-tempore-dicta-aliquid-est',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/upload-from-url"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"url": "http:\/\/www.wyman.com\/excepturi-ducimus-tempore-dicta-aliquid-est"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Files
Upload and manage company files and attachments. Store documents that can be referenced in proposals, emails, and customer communications.
Store
requires authentication
Upload a file into a company
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/files" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=magni"\
--form "description=Fugiat saepe omnis ratione et."\
--form "directory=proposal-template"\
--form "type=document"\
--form "fileUpload=@/tmp/phpe2v80L" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/files';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'magni'
],
[
'name' => 'description',
'contents' => 'Fugiat saepe omnis ratione et.'
],
[
'name' => 'directory',
'contents' => 'proposal-template'
],
[
'name' => 'type',
'contents' => 'document'
],
[
'name' => 'fileUpload',
'contents' => fopen('/tmp/phpe2v80L', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/files"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'magni');
body.append('description', 'Fugiat saepe omnis ratione et.');
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a file from a company
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/files" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"file_url\": \"http:\\/\\/www.bartell.com\\/tempore-voluptatem-quasi-quia-perspiciatis-illum-harum.html\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/files';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'file_url' => 'http://www.bartell.com/tempore-voluptatem-quasi-quia-perspiciatis-illum-harum.html',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/files"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"file_url": "http:\/\/www.bartell.com\/tempore-voluptatem-quasi-quia-perspiciatis-illum-harum.html"
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Form Fields
Define individual fields (text, dropdown, checkbox, date, etc.) that make up custom forms. Configure field validation rules, options, and display settings.
List
requires authentication
Shows the list of form fields with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields?page=18&page_size=11&sort_by=quia&sort_order=sit&search=praesentium" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '18',
'page_size' => '11',
'sort_by' => 'quia',
'sort_order' => 'sit',
'search' => 'praesentium',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields"
);
const params = {
"page": "18",
"page_size": "11",
"sort_by": "quia",
"sort_order": "sit",
"search": "praesentium",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single form field.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created formField.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"label\": \"hic\",
\"input_type\": \"quis\",
\"default_value\": \"similique\",
\"is_required\": true,
\"is_conditional\": true,
\"has_help_guide\": false,
\"conditional_value\": \"ut\",
\"help_guide\": \"est\",
\"position\": 17
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'label' => 'hic',
'input_type' => 'quis',
'default_value' => 'similique',
'is_required' => true,
'is_conditional' => true,
'has_help_guide' => false,
'conditional_value' => 'ut',
'help_guide' => 'est',
'position' => 17,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"label": "hic",
"input_type": "quis",
"default_value": "similique",
"is_required": true,
"is_conditional": true,
"has_help_guide": false,
"conditional_value": "ut",
"help_guide": "est",
"position": 17
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a formfield.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"label\": \"voluptatibus\",
\"input_type\": \"adipisci\",
\"default_value\": \"aut\",
\"is_required\": true,
\"is_conditional\": false,
\"has_help_guide\": true,
\"conditional_value\": \"sit\",
\"help_guide\": \"eos\",
\"position\": 12
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'label' => 'voluptatibus',
'input_type' => 'adipisci',
'default_value' => 'aut',
'is_required' => true,
'is_conditional' => false,
'has_help_guide' => true,
'conditional_value' => 'sit',
'help_guide' => 'eos',
'position' => 12,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"label": "voluptatibus",
"input_type": "adipisci",
"default_value": "aut",
"is_required": true,
"is_conditional": false,
"has_help_guide": true,
"conditional_value": "sit",
"help_guide": "eos",
"position": 12
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a formfield.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"label\": \"eum\",
\"input_type\": \"ea\",
\"default_value\": \"est\",
\"is_required\": true,
\"is_conditional\": false,
\"has_help_guide\": false,
\"conditional_value\": \"ex\",
\"help_guide\": \"magnam\",
\"position\": 13
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'label' => 'eum',
'input_type' => 'ea',
'default_value' => 'est',
'is_required' => true,
'is_conditional' => false,
'has_help_guide' => false,
'conditional_value' => 'ex',
'help_guide' => 'magnam',
'position' => 13,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"label": "eum",
"input_type": "ea",
"default_value": "est",
"is_required": true,
"is_conditional": false,
"has_help_guide": false,
"conditional_value": "ex",
"help_guide": "magnam",
"position": 13
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company form field.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"label\": \"nobis\",
\"input_type\": \"est\",
\"default_value\": \"modi\",
\"is_required\": false,
\"is_conditional\": true,
\"has_help_guide\": true,
\"conditional_value\": \"enim\",
\"help_guide\": \"reiciendis\",
\"position\": 15
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'label' => 'nobis',
'input_type' => 'est',
'default_value' => 'modi',
'is_required' => false,
'is_conditional' => true,
'has_help_guide' => true,
'conditional_value' => 'enim',
'help_guide' => 'reiciendis',
'position' => 15,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"label": "nobis",
"input_type": "est",
"default_value": "modi",
"is_required": false,
"is_conditional": true,
"has_help_guide": true,
"conditional_value": "enim",
"help_guide": "reiciendis",
"position": 15
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a form field.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Forms
Build custom data collection forms with form fields and assignments. Forms can be attached to proposals for customer completion or used during service delivery to collect business-specific information.
List
requires authentication
Shows the list of form with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms?page=1&page_size=9&sort_by=in&sort_order=iusto&search=ab" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'page_size' => '9',
'sort_by' => 'in',
'sort_order' => 'iusto',
'search' => 'ab',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms"
);
const params = {
"page": "1",
"page_size": "9",
"sort_by": "in",
"sort_order": "iusto",
"search": "ab",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get form types
requires authentication
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/form-types" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single form.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created form.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"libero\",
\"assignment\": \"deserunt\",
\"form_fields\": [
\"ut\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'libero',
'assignment' => 'deserunt',
'form_fields' => [
'ut',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "libero",
"assignment": "deserunt",
"form_fields": [
"ut"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Duplicate
requires authentication
Duplicate form
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a form.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"adipisci\",
\"assignment\": \"cupiditate\",
\"form_fields\": [
\"soluta\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'adipisci',
'assignment' => 'cupiditate',
'form_fields' => [
'soluta',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "adipisci",
"assignment": "cupiditate",
"form_fields": [
"soluta"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a form.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"autem\",
\"assignment\": \"est\",
\"form_fields\": [
\"hic\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'autem',
'assignment' => 'est',
'form_fields' => [
'hic',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "autem",
"assignment": "est",
"form_fields": [
"hic"
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company form.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"quos\",
\"assignment\": \"recusandae\",
\"form_fields\": [
\"voluptas\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'quos',
'assignment' => 'recusandae',
'form_fields' => [
'voluptas',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "quos",
"assignment": "recusandae",
"form_fields": [
"voluptas"
]
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a form.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/forms/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import Sets
Manage bulk data import jobs for migrating customers, service plans, line items, and other records from external systems or CSV files.
Apply Import Set to Company
requires authentication
Store a newly created import set.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-defaults" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"tags\": [
\"eaque\"
],
\"import_files\": \"dicta\",
\"override\": false,
\"admin_only\": false
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-defaults';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'tags' => [
'eaque',
],
'import_files' => 'dicta',
'override' => false,
'admin_only' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-defaults"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"tags": [
"eaque"
],
"import_files": "dicta",
"override": false,
"admin_only": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Apply Import Set to Company
requires authentication
Store a newly created import set.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-defaults/upload" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"tags\": [
\"aut\"
],
\"import_files\": \"vitae\",
\"override\": true,
\"admin_only\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-defaults/upload';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'tags' => [
'aut',
],
'import_files' => 'vitae',
'override' => true,
'admin_only' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-defaults/upload"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"tags": [
"aut"
],
"import_files": "vitae",
"override": true,
"admin_only": true
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List
requires authentication
Shows the list of import set with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/import-sets?page=1&page_size=17&sort_by=alias&sort_order=pariatur&search=voluptatibus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-sets';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'page_size' => '17',
'sort_by' => 'alias',
'sort_order' => 'pariatur',
'search' => 'voluptatibus',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/import-sets"
);
const params = {
"page": "1",
"page_size": "17",
"sort_by": "alias",
"sort_order": "pariatur",
"search": "voluptatibus",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single import set.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Download
requires authentication
Download a single import set.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6/download" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6/download"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created import set.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/import-sets" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"tags\": [
\"esse\"
],
\"import_files\": \"voluptas\",
\"override\": true,
\"admin_only\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => [
'esse',
],
'import_files' => 'voluptas',
'override' => true,
'admin_only' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/import-sets"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"tags": [
"esse"
],
"import_files": "voluptas",
"override": true,
"admin_only": true
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a import set.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"import_files\": \"at\",
\"admin_only\": false,
\"is_selected\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'import_files' => 'at',
'admin_only' => false,
'is_selected' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"import_files": "at",
"admin_only": false,
"is_selected": true
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update the specified resource in storage.
requires authentication
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"admin_only\": false,
\"is_selected\": false
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'admin_only' => false,
'is_selected' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"admin_only": false,
"is_selected": false
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a import set.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/import-sets/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List Forms
requires authentication
Shows the list of import set with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/form-import-sets?page=8&page_size=16&sort_by=nesciunt&sort_order=qui&search=minima" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.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',
],
'query' => [
'page' => '8',
'page_size' => '16',
'sort_by' => 'nesciunt',
'sort_order' => 'qui',
'search' => 'minima',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/form-import-sets"
);
const params = {
"page": "8",
"page_size": "16",
"sort_by": "nesciunt",
"sort_order": "qui",
"search": "minima",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Apply Import Set to Company
requires authentication
Store a newly created import set.
Example request:
curl --request POST \
"https://staging.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\": [
\"possimus\"
],
\"import_files\": \"accusantium\",
\"override\": false,
\"admin_only\": false
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => [
'possimus',
],
'import_files' => 'accusantium',
'override' => false,
'admin_only' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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": [
"possimus"
],
"import_files": "accusantium",
"override": false,
"admin_only": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import Types
View available import types and data formats supported for bulk data migration (customers, service plans, line items, categories, etc.).
List
requires authentication
Shows the list of tags with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/import-types?page=13&page_size=8&sort_by=repudiandae&sort_order=doloremque&search=nihil" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/import-types';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '13',
'page_size' => '8',
'sort_by' => 'repudiandae',
'sort_order' => 'doloremque',
'search' => 'nihil',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/import-types"
);
const params = {
"page": "13",
"page_size": "8",
"sort_by": "repudiandae",
"sort_order": "doloremque",
"search": "nihil",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Industries
Retrieve industry classifications for commercial customers (restaurants, warehouses, offices, etc.). Used to categorize commercial accounts by business type for reporting and segmentation.
Fetch all available industry
requires authentication
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Integration Types
View available integration types (CRM systems, accounting software, etc.) that can be connected to Smarter Launch. Integration availability may be restricted by company settings and user role.
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://staging.api.smarterlaunch.com/api/v1/integration-types/1/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/integration-types/1/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://staging.api.smarterlaunch.com/api/v1/integration-types/1/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Integrations
Connect and manage integrations with external CRM systems, accounting software, and other business tools. Configure integration settings, sync data, and view integration logs.
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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List
requires authentication
Shows the list of integrations for a company
Note: Integration logs are NOT included in list responses for performance reasons. Use the GET /logs endpoint to retrieve logs for a specific integration.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Shows a single item of integrations for a company
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Create a company integration with empty credential values
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"credentials\": [
\"illum\"
],
\"status_uuid\": \"6d585bee-31fb-3b86-8f38-37ccebb01b30\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'credentials' => [
'illum',
],
'status_uuid' => '6d585bee-31fb-3b86-8f38-37ccebb01b30',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"credentials": [
"illum"
],
"status_uuid": "6d585bee-31fb-3b86-8f38-37ccebb01b30"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"credentials\": [
\"voluptate\"
],
\"status_uuid\": \"d451bd0a-136d-3718-880a-590bbe6067a1\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'credentials' => [
'voluptate',
],
'status_uuid' => 'd451bd0a-136d-3718-880a-590bbe6067a1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"credentials": [
"voluptate"
],
"status_uuid": "d451bd0a-136d-3718-880a-590bbe6067a1"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
This endpoint allows user to delete a Company Integration.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/integrations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Line Items
Manage additional services and products that can be added to proposals. Line items include pricing information, billing schedules, service schedules, and can be imported in bulk.
List
requires authentication
Shows the list of line items with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items?page=1&page_size=12&sort_by=illum&sort_order=qui&search=reiciendis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '1',
'page_size' => '12',
'sort_by' => 'illum',
'sort_order' => 'qui',
'search' => 'reiciendis',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items"
);
const params = {
"page": "1",
"page_size": "12",
"sort_by": "illum",
"sort_order": "qui",
"search": "reiciendis",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single line item.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a new line item.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"maxime\",
\"description\": \"Id sed eos excepturi exercitationem non quos nihil.\",
\"line_item_values\": \"nemo\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'maxime',
'description' => 'Id sed eos excepturi exercitationem non quos nihil.',
'line_item_values' => 'nemo',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "maxime",
"description": "Id sed eos excepturi exercitationem non quos nihil.",
"line_item_values": "nemo"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import Set to Line Items
requires authentication
Store a newly created import set.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/import" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"import_files\": \"ipsam\",
\"override\": false
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/import';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'import_files' => 'ipsam',
'override' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/import"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"import_files": "ipsam",
"override": false
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a line item.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"deleniti\",
\"description\": \"Ut et et dolorum ipsum.\",
\"line_item_values\": \"blanditiis\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'deleniti',
'description' => 'Ut et et dolorum ipsum.',
'line_item_values' => 'blanditiis',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "deleniti",
"description": "Ut et et dolorum ipsum.",
"line_item_values": "blanditiis"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Update a line item.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"cupiditate\",
\"description\": \"Odio quia molestiae qui et nesciunt dignissimos quo.\",
\"line_item_values\": \"ut\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'cupiditate',
'description' => 'Odio quia molestiae qui et nesciunt dignissimos quo.',
'line_item_values' => 'ut',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "cupiditate",
"description": "Odio quia molestiae qui et nesciunt dignissimos quo.",
"line_item_values": "ut"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a line item.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/line-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Location Custom Settings
Configure location-specific operational settings and preferences that override company-level defaults for individual branches.
List
requires authentication
Shows the list of do with filter or single template page data.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show detail of a company location setting
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Create a company location custom setting
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a company location custom setting
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Deletes a company location custom setting
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-settings/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Locations
Manage company branch locations and service territories. Configure location-specific settings, assign service plans, manage user access by location, and set up integration settings for each branch.
List
requires authentication
Shows the list of locations with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations?page=7&page_size=6&sort_by=placeat&sort_order=sit&search=omnis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '7',
'page_size' => '6',
'sort_by' => 'placeat',
'sort_order' => 'sit',
'search' => 'omnis',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations"
);
const params = {
"page": "7",
"page_size": "6",
"sort_by": "placeat",
"sort_order": "sit",
"search": "omnis",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Shows the detail of a specific company location.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"withTemplates\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
This endpoint lets user to create single record using uuid.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update All
requires authentication
This endpoint lets user to update multiple record using uuids.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/updateAll" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Edit
requires authentication
This endpoint lets user to update single record using uuid (using PUT method).
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
This endpoint lets user to update single record using uuid.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
This endpoint enables user to delete a company location
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Integration Data
requires authentication
Get data from a 3rd party API
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6/integration-data" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/locations/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Media Items
Manage photos, videos, and documents used in proposals and service documentation. Organize media with tags and sources for easy retrieval and reuse across projects.
List
requires authentication
Shows the list of media items with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/media-items?page=10&page_size=17&sort_by=architecto&sort_order=repellat&search=numquam" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"company_uuid\": \"ea0e1af0-9810-3e39-85fd-220378c11615\",
\"company_location_uuid\": \"102e8fef-51f7-39e8-8091-94f28cc24962\",
\"media_source_uuid\": \"791de5c6-aeb8-3cec-9a81-4bba3e9c7786\",
\"include_global_files\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-items';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '10',
'page_size' => '17',
'sort_by' => 'architecto',
'sort_order' => 'repellat',
'search' => 'numquam',
],
'json' => [
'company_uuid' => 'ea0e1af0-9810-3e39-85fd-220378c11615',
'company_location_uuid' => '102e8fef-51f7-39e8-8091-94f28cc24962',
'media_source_uuid' => '791de5c6-aeb8-3cec-9a81-4bba3e9c7786',
'include_global_files' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-items"
);
const params = {
"page": "10",
"page_size": "17",
"sort_by": "architecto",
"sort_order": "repellat",
"search": "numquam",
};
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 = {
"company_uuid": "ea0e1af0-9810-3e39-85fd-220378c11615",
"company_location_uuid": "102e8fef-51f7-39e8-8091-94f28cc24962",
"media_source_uuid": "791de5c6-aeb8-3cec-9a81-4bba3e9c7786",
"include_global_files": true
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single media item
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Upload a media item
Example request:
curl --request POST \
"https://staging.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=explicabo"\
--form "description=Cum modi aliquam est dolorum velit."\
--form "directory=proposal-template"\
--form "type=document"\
--form "fileUpload=@/tmp/phpFonrBL" $client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'explicabo'
],
[
'name' => 'description',
'contents' => 'Cum modi aliquam est dolorum velit.'
],
[
'name' => 'directory',
'contents' => 'proposal-template'
],
[
'name' => 'type',
'contents' => 'document'
],
[
'name' => 'fileUpload',
'contents' => fopen('/tmp/phpFonrBL', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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', 'explicabo');
body.append('description', 'Cum modi aliquam est dolorum velit.');
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a media item.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"sit\",
\"description\": \"Et a non adipisci delectus vero.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'sit',
'description' => 'Et a non adipisci delectus vero.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "sit",
"description": "Et a non adipisci delectus vero."
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a media item.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"omnis\",
\"description\": \"Omnis eos eum minima itaque.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'omnis',
'description' => 'Omnis eos eum minima itaque.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "omnis",
"description": "Omnis eos eum minima itaque."
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a media item.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/media-items/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Media Sources
Define and manage sources for media files (uploaded, camera, external URL, imports) to track where images and documents originated.
List
requires authentication
Shows the list of media source with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/media-sources?page=20&page_size=19&sort_by=et&sort_order=sit&search=maxime" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '20',
'page_size' => '19',
'sort_by' => 'et',
'sort_order' => 'sit',
'search' => 'maxime',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources"
);
const params = {
"page": "20",
"page_size": "19",
"sort_by": "et",
"sort_order": "sit",
"search": "maxime",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Favorite Media Source List
requires authentication
Get the list of favorite Media Sources
Example request:
curl --request GET \
--get "https://staging.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\": \"sit\",
\"description\": \"Maxime aut mollitia aliquam illo sit.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'sit',
'description' => 'Maxime aut mollitia aliquam illo sit.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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": "sit",
"description": "Maxime aut mollitia aliquam illo sit."
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single media source
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Upload a media source
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/media-sources" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"maiores\",
\"description\": \"Fuga fuga atque sit et.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'maiores',
'description' => 'Fuga fuga atque sit et.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "maiores",
"description": "Fuga fuga atque sit et."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add to Favorite
requires authentication
Add media source to the user company's media source favorites
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/favorites" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"et\",
\"description\": \"Quod maiores iure ipsam.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/favorites';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'et',
'description' => 'Quod maiores iure ipsam.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/favorites"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "et",
"description": "Quod maiores iure ipsam."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Import CSV
requires authentication
Accept CSV and populate media item data for a media source/manufacturer
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/import-csv" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file=@/tmp/phpKpuHlJ" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpKpuHlJ', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a media source.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"mollitia\",
\"description\": \"Vel aspernatur nihil et sunt earum ipsam.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'mollitia',
'description' => 'Vel aspernatur nihil et sunt earum ipsam.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "mollitia",
"description": "Vel aspernatur nihil et sunt earum ipsam."
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a media source.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ut\",
\"description\": \"Placeat non eos eius omnis aut magni fuga.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'ut',
'description' => 'Placeat non eos eius omnis aut magni fuga.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "ut",
"description": "Placeat non eos eius omnis aut magni fuga."
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a media source.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove Favorite Media Source
requires authentication
Remove media source to the user company's media source favorites
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/favorites" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"aliquid\",
\"description\": \"Qui sit officiis reiciendis fugiat molestiae mollitia.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/favorites';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'aliquid',
'description' => 'Qui sit officiis reiciendis fugiat molestiae mollitia.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/media-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6/favorites"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "aliquid",
"description": "Qui sit officiis reiciendis fugiat molestiae mollitia."
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Media Tags
Create tags to categorize and organize media files (photos, videos, documents) for easy retrieval and reuse across proposals and service documentation.
List
requires authentication
Shows the list of media tag with pagination.
Show
requires authentication
Show a single media tag
Store
requires authentication
Upload a media tag
Update
requires authentication
Update a media tag.
Patch
requires authentication
Patch a media tag.
Delete
requires authentication
Delete a media tag.
Permissions
View available system permissions that can be assigned to roles for granular access control. Permissions control access to features and data throughout the application.
List / Fetch
requires authentication
Shows the list of permission or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List / Fetch
requires authentication
Shows the list of permission or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/permissions/{permissionUuid}" \
--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://staging.api.smarterlaunch.com/api/v1/permissions/{permissionUuid}';
$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://staging.api.smarterlaunch.com/api/v1/permissions/{permissionUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create / Update permission.
requires authentication
This endpoint lets user to create/update permission.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create / Update permission.
requires authentication
This endpoint lets user to create/update permission.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/permissions/{permissionUuid}" \
--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://staging.api.smarterlaunch.com/api/v1/permissions/{permissionUuid}';
$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://staging.api.smarterlaunch.com/api/v1/permissions/{permissionUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
This endpoint allows user to delete permission.
Example request:
curl --request DELETE \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Pest Treated
List
requires authentication
Shows the list of pest treated with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single pest treated.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created pest treated.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=sequi"\
--form "pest_treated_attributes[attr]=value"\
--form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
--form "pest_treated="\
--form "photo_file=@/tmp/phpHZluSK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'sequi'
],
[
'name' => 'pest_treated_attributes[attr]',
'contents' => 'value'
],
[
'name' => 'icon_image_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'pest_treated',
'contents' => ''
],
[
'name' => 'photo_file',
'contents' => fopen('/tmp/phpHZluSK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'sequi');
body.append('pest_treated_attributes[attr]', 'value');
body.append('icon_image_url', 'http://smarterlaunch.local/image1.jpg');
body.append('pest_treated', '');
body.append('photo_file', document.querySelector('input[name="photo_file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a pest treated.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=voluptatem"\
--form "pest_treated_attributes[attr]=value"\
--form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
--form "photo_file=@/tmp/phpJNaZQK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'voluptatem'
],
[
'name' => 'pest_treated_attributes[attr]',
'contents' => 'value'
],
[
'name' => 'icon_image_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'photo_file',
'contents' => fopen('/tmp/phpJNaZQK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'voluptatem');
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a pest treated.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=aut"\
--form "pest_treated_attributes[attr]=value"\
--form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
--form "photo_file=@/tmp/phpETFaOL" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'aut'
],
[
'name' => 'pest_treated_attributes[attr]',
'contents' => 'value'
],
[
'name' => 'icon_image_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'photo_file',
'contents' => fopen('/tmp/phpETFaOL', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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('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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company pest treated.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=illo"\
--form "pest_treated_attributes[attr]=value"\
--form "icon_image_url=http://smarterlaunch.local/image1.jpg"\
--form "photo_file=@/tmp/phpAZ6AML" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'illo'
],
[
'name' => 'pest_treated_attributes[attr]',
'contents' => 'value'
],
[
'name' => 'icon_image_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'photo_file',
'contents' => fopen('/tmp/phpAZ6AML', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'illo');
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a pest treated.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/pests-treated/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Products
Manage pest control products and chemicals used in treatments. Track product information for service documentation, inventory tracking, and compliance reporting.
List
requires authentication
Shows the list of company products with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products?page=7&page_size=8&sort_by=enim&sort_order=eum&search=magnam" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '7',
'page_size' => '8',
'sort_by' => 'enim',
'sort_order' => 'eum',
'search' => 'magnam',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products"
);
const params = {
"page": "7",
"page_size": "8",
"sort_by": "enim",
"sort_order": "eum",
"search": "magnam",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single company product.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created company product.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"placeat\",
\"product_attributes\": {
\"attr\": \"value\"
},
\"label_image_url\": \"http:\\/\\/smarterlaunch.local\\/image1.jpg\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'placeat',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "placeat",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a company product.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ea\",
\"product_attributes\": {
\"attr\": \"value\"
},
\"label_image_url\": \"http:\\/\\/smarterlaunch.local\\/image1.jpg\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'ea',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "ea",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company product.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"eveniet\",
\"product_attributes\": {
\"attr\": \"value\"
},
\"label_image_url\": \"http:\\/\\/smarterlaunch.local\\/image1.jpg\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'eveniet',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "eveniet",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a product.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/products/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Property Locations
Define standardized property location types (interior, exterior, basement, attic, garage, etc.) used in service diagrams and treatment records.
List
requires authentication
Shows the list of property locations with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations?page=11&page_size=15&sort_by=optio&sort_order=suscipit&search=nesciunt" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '11',
'page_size' => '15',
'sort_by' => 'optio',
'sort_order' => 'suscipit',
'search' => 'nesciunt',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations"
);
const params = {
"page": "11",
"page_size": "15",
"sort_by": "optio",
"sort_order": "suscipit",
"search": "nesciunt",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single property location.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created property location.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"dicta\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'dicta',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "dicta"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a property location.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"qui\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'qui',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "qui"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company property location.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"voluptatibus\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'voluptatibus',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "voluptatibus"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a property location.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/property-locations/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Proposal Templates
List
requires authentication
Shows the list of ProposalTemplates with pagination.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created Proposal Template.
Example request:
curl --request POST \
"https://staging.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\": \"71da6128-f400-3a3e-a5d1-77dc096e1ae8\",
\"title\": \"omnis\",
\"description\": \"Aspernatur quos laudantium sit rerum tempore aut.\",
\"settings\": {
\"attr\": \"value\"
},
\"service_plan_uuids\": [
\"815d3d9c-f371-3781-8456-7e6954b5b0f5\",
\"815d3d9c-f371-3781-8456-7e6954b5b0f5\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => '71da6128-f400-3a3e-a5d1-77dc096e1ae8',
'title' => 'omnis',
'description' => 'Aspernatur quos laudantium sit rerum tempore aut.',
'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://staging.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": "71da6128-f400-3a3e-a5d1-77dc096e1ae8",
"title": "omnis",
"description": "Aspernatur quos laudantium sit rerum tempore aut.",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Duplicate
requires authentication
Duplicate a proposal template
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single proposal template.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a proposal template.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"company_location_uuid\": \"d37d849d-a34e-36ec-a5b4-0a14d95b48ef\",
\"title\": \"aut\",
\"description\": \"Reiciendis placeat earum quia est non provident in natus.\",
\"settings\": {
\"attr\": \"value\"
},
\"service_plan_uuids\": [
\"815d3d9c-f371-3781-8456-7e6954b5b0f5\",
\"815d3d9c-f371-3781-8456-7e6954b5b0f5\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'company_location_uuid' => 'd37d849d-a34e-36ec-a5b4-0a14d95b48ef',
'title' => 'aut',
'description' => 'Reiciendis placeat earum quia est non provident in natus.',
'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://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"company_location_uuid": "d37d849d-a34e-36ec-a5b4-0a14d95b48ef",
"title": "aut",
"description": "Reiciendis placeat earum quia est non provident in natus.",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company proposal template.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"company_location_uuid\": \"51414968-5bc1-3005-ad24-f94b3e5a1420\",
\"title\": \"repellendus\",
\"description\": \"Et et iste ducimus repudiandae.\",
\"settings\": {
\"attr\": \"value\"
},
\"service_plan_uuids\": [
\"815d3d9c-f371-3781-8456-7e6954b5b0f5\",
\"815d3d9c-f371-3781-8456-7e6954b5b0f5\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'company_location_uuid' => '51414968-5bc1-3005-ad24-f94b3e5a1420',
'title' => 'repellendus',
'description' => 'Et et iste ducimus repudiandae.',
'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://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"company_location_uuid": "51414968-5bc1-3005-ad24-f94b3e5a1420",
"title": "repellendus",
"description": "Et et iste ducimus repudiandae.",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a proposal template.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/proposals/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Proposals
Create and manage pest control service proposals. Handle proposal creation, customer acceptance/decline with digital signatures, pricing selection, custom form submissions, activity tracking, file attachments, and CRM synchronization.
Get
requires authentication
Display the selected proposal.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/preview" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/preview"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get client IP Address and Date time prior to accepting the proposal
requires authentication
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/get-ip-datetime" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store Proposal Inquiry
requires authentication
Send inquiry request from users
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Upload
requires authentication
Upload photos for Cover Letter or Photo Layout pages
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/{supportRequestUuid}/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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/{supportRequestUuid}/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://staging.api.smarterlaunch.com/api/v1/companies/{company_uuid}/proposals/{proposal_uuid}/{supportRequestUuid}/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Accept and Sign
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/accept-sign" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"signature_photo_url\": \"http:\\/\\/www.altenwerth.org\\/similique-iste-et-iste-qui-voluptatem-labore\",
\"proposal_pdf_url\": \"https:\\/\\/swaniawski.biz\\/quibusdam-sit-distinctio-est-ex-fugiat-ipsa-recusandae.html\",
\"auth_code\": \"magni\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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.altenwerth.org/similique-iste-et-iste-qui-voluptatem-labore',
'proposal_pdf_url' => 'https://swaniawski.biz/quibusdam-sit-distinctio-est-ex-fugiat-ipsa-recusandae.html',
'auth_code' => 'magni',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/accept-sign"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"signature_photo_url": "http:\/\/www.altenwerth.org\/similique-iste-et-iste-qui-voluptatem-labore",
"proposal_pdf_url": "https:\/\/swaniawski.biz\/quibusdam-sit-distinctio-est-ex-fugiat-ipsa-recusandae.html",
"auth_code": "magni"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Replicate Signature
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/replace-signature" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"signature_photo_url\": \"http:\\/\\/bergstrom.com\\/ratione-aut-est-nemo-minus-laboriosam-similique.html\",
\"proposal_pdf_url\": \"http:\\/\\/www.klocko.org\\/mollitia-recusandae-accusantium-similique-soluta-quis-deserunt-consequatur\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/replace-signature';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'signature_photo_url' => 'http://bergstrom.com/ratione-aut-est-nemo-minus-laboriosam-similique.html',
'proposal_pdf_url' => 'http://www.klocko.org/mollitia-recusandae-accusantium-similique-soluta-quis-deserunt-consequatur',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/replace-signature"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"signature_photo_url": "http:\/\/bergstrom.com\/ratione-aut-est-nemo-minus-laboriosam-similique.html",
"proposal_pdf_url": "http:\/\/www.klocko.org\/mollitia-recusandae-accusantium-similique-soluta-quis-deserunt-consequatur"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Attached Document
requires authentication
Patch the specified proposal.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/update-attachment" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "documentIndex=2799390.8577753"\
--form "keyName=attached_documents"\
--form "documentFile=@/tmp/phpn86weN" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/update-attachment';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'documentIndex',
'contents' => '2799390.8577753'
],
[
'name' => 'keyName',
'contents' => 'attached_documents'
],
[
'name' => 'documentFile',
'contents' => fopen('/tmp/phpn86weN', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/update-attachment"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('documentIndex', '2799390.8577753');
body.append('keyName', 'attached_documents');
body.append('documentFile', document.querySelector('input[name="documentFile"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Log Video Clicked
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/video-clicked" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"video_type\": \"id\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/video-clicked';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'video_type' => 'id',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/video-clicked"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"video_type": "id"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Decline
requires authentication
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/decline"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update Selected Pricing
requires authentication
Patch the specified proposal.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Submit Customer Forms
requires authentication
Patch the specified proposal.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List
requires authentication
Shows the list of proposal with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals?page=10&page_size=10&sort_by=reprehenderit&sort_order=laudantium&search=qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"ignore_cached\": false,
\"date_range_start\": \"2025-12-08T19:12:42\",
\"date_range_end\": \"2026-06-04\",
\"timezone\": \"America\\/Argentina\\/Jujuy\",
\"company_location_uuid\": \"a34fb0a0-3a86-3a9a-a393-59aea8688844\",
\"team_uuid\": \"62f46e97-a483-3bd3-8635-69bc5b305541\",
\"user_uuid\": \"19116d6d-b417-30d6-9937-90ac511afa9c\",
\"template_uuid\": \"8a8401dd-1306-3232-bb56-817702126fe5\",
\"status_uuid\": [
\"45c17efa-475e-38f9-a783-6d677a1a08fe\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '10',
'page_size' => '10',
'sort_by' => 'reprehenderit',
'sort_order' => 'laudantium',
'search' => 'qui',
],
'json' => [
'ignore_cached' => false,
'date_range_start' => '2025-12-08T19:12:42',
'date_range_end' => '2026-06-04',
'timezone' => 'America/Argentina/Jujuy',
'company_location_uuid' => 'a34fb0a0-3a86-3a9a-a393-59aea8688844',
'team_uuid' => '62f46e97-a483-3bd3-8635-69bc5b305541',
'user_uuid' => '19116d6d-b417-30d6-9937-90ac511afa9c',
'template_uuid' => '8a8401dd-1306-3232-bb56-817702126fe5',
'status_uuid' => [
'45c17efa-475e-38f9-a783-6d677a1a08fe',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals"
);
const params = {
"page": "10",
"page_size": "10",
"sort_by": "reprehenderit",
"sort_order": "laudantium",
"search": "qui",
};
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,
"date_range_start": "2025-12-08T19:12:42",
"date_range_end": "2026-06-04",
"timezone": "America\/Argentina\/Jujuy",
"company_location_uuid": "a34fb0a0-3a86-3a9a-a393-59aea8688844",
"team_uuid": "62f46e97-a483-3bd3-8635-69bc5b305541",
"user_uuid": "19116d6d-b417-30d6-9937-90ac511afa9c",
"template_uuid": "8a8401dd-1306-3232-bb56-817702126fe5",
"status_uuid": [
"45c17efa-475e-38f9-a783-6d677a1a08fe"
]
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Export List
requires authentication
Returns a CSV file of list of filtered proposal list.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/export-list?page=6&page_size=13&sort_by=voluptatem&sort_order=nihil&search=est" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.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',
],
'query' => [
'page' => '6',
'page_size' => '13',
'sort_by' => 'voluptatem',
'sort_order' => 'nihil',
'search' => 'est',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/export-list"
);
const params = {
"page": "6",
"page_size": "13",
"sort_by": "voluptatem",
"sort_order": "nihil",
"search": "est",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Summary
requires authentication
Shows the summary of proposal. Returns number of items per Proposal status.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get
requires authentication
Display the selected proposal.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List of Activity Logs
requires authentication
Shows the list of proposal's activity logs with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs?page=15&page_size=2&sort_by=consequuntur&sort_order=ut&search=nisi" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '15',
'page_size' => '2',
'sort_by' => 'consequuntur',
'sort_order' => 'ut',
'search' => 'nisi',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs"
);
const params = {
"page": "15",
"page_size": "2",
"sort_by": "consequuntur",
"sort_order": "ut",
"search": "nisi",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get the events associated with a specific proposal activity
requires authentication
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity/1/events" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity/1/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity/1/events"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Download TARF XML
requires authentication
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/tarf-xml-url" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Download California WDO XML
requires authentication
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Store a newly created proposal activity entry
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.action
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1/1';
$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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Store a newly created proposal.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"doloremque\",
\"description\": \"Pariatur qui et provident est excepturi deleniti soluta.\",
\"company_location_uuid\": \"febec167-7ce0-31f4-8104-6f0045eb30fb\",
\"customer_uuid\": \"3ba139fb-11fa-3202-8a99-eeff8ca6c664\",
\"customer_address_uuid\": \"f33852dd-3f48-3318-926f-d8927565df30\",
\"status_uuid\": \"6013e118-694d-3246-bbd5-f8579d471168\",
\"service_plan_uuids\": [
\"autem\"
],
\"proposal_values\": [],
\"proposal_template_uuid\": \"09692398-b6ec-3447-a596-14912bab5112\",
\"metadata\": []
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'doloremque',
'description' => 'Pariatur qui et provident est excepturi deleniti soluta.',
'company_location_uuid' => 'febec167-7ce0-31f4-8104-6f0045eb30fb',
'customer_uuid' => '3ba139fb-11fa-3202-8a99-eeff8ca6c664',
'customer_address_uuid' => 'f33852dd-3f48-3318-926f-d8927565df30',
'status_uuid' => '6013e118-694d-3246-bbd5-f8579d471168',
'service_plan_uuids' => [
'autem',
],
'proposal_values' => [],
'proposal_template_uuid' => '09692398-b6ec-3447-a596-14912bab5112',
'metadata' => [],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "doloremque",
"description": "Pariatur qui et provident est excepturi deleniti soluta.",
"company_location_uuid": "febec167-7ce0-31f4-8104-6f0045eb30fb",
"customer_uuid": "3ba139fb-11fa-3202-8a99-eeff8ca6c664",
"customer_address_uuid": "f33852dd-3f48-3318-926f-d8927565df30",
"status_uuid": "6013e118-694d-3246-bbd5-f8579d471168",
"service_plan_uuids": [
"autem"
],
"proposal_values": [],
"proposal_template_uuid": "09692398-b6ec-3447-a596-14912bab5112",
"metadata": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Duplicate
requires authentication
This endpoint lets user to duplicate proposal and set into a draft mode
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Upload Review Photo
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpREIyNI" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpREIyNI', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Resync document
requires authentication
Resync document the specified proposal.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/push-to-crm" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"voluptate\",
\"description\": \"Eius rerum et quae est aspernatur nulla in.\",
\"company_location_uuid\": \"c581514b-207c-3c7d-bae4-e5165bfd46ef\",
\"customer_uuid\": \"bbaeea84-7d49-3f98-b832-3655cb3d6d92\",
\"customer_address_uuid\": \"366bf105-de63-3e8d-8a17-f0cc2d942c01\",
\"status_uuid\": \"b1e808d4-cb51-3305-a94a-ef0978c35c8a\",
\"service_plan_uuids\": [
\"voluptatem\"
],
\"proposal_values\": [],
\"proposal_template_uuid\": \"e9f93f6f-92ee-39ed-821a-809e565609c1\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/push-to-crm';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'voluptate',
'description' => 'Eius rerum et quae est aspernatur nulla in.',
'company_location_uuid' => 'c581514b-207c-3c7d-bae4-e5165bfd46ef',
'customer_uuid' => 'bbaeea84-7d49-3f98-b832-3655cb3d6d92',
'customer_address_uuid' => '366bf105-de63-3e8d-8a17-f0cc2d942c01',
'status_uuid' => 'b1e808d4-cb51-3305-a94a-ef0978c35c8a',
'service_plan_uuids' => [
'voluptatem',
],
'proposal_values' => [],
'proposal_template_uuid' => 'e9f93f6f-92ee-39ed-821a-809e565609c1',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/push-to-crm"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "voluptate",
"description": "Eius rerum et quae est aspernatur nulla in.",
"company_location_uuid": "c581514b-207c-3c7d-bae4-e5165bfd46ef",
"customer_uuid": "bbaeea84-7d49-3f98-b832-3655cb3d6d92",
"customer_address_uuid": "366bf105-de63-3e8d-8a17-f0cc2d942c01",
"status_uuid": "b1e808d4-cb51-3305-a94a-ef0978c35c8a",
"service_plan_uuids": [
"voluptatem"
],
"proposal_values": [],
"proposal_template_uuid": "e9f93f6f-92ee-39ed-821a-809e565609c1"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Updates the specified proposal.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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\": \"804369f0-754f-3ac0-9893-8791b44b212a\",
\"customer_uuid\": \"7766c640-0f78-30bf-b2c9-0e99c7eb2590\",
\"customer_address_uuid\": \"a091ba18-1887-38c1-879d-f8f0ca2c17a5\",
\"status_uuid\": \"f38ef51e-9806-394d-8d91-3b6b7ff60a8c\",
\"service_plan_uuids\": [
\"tempore\"
],
\"proposal_values\": [],
\"proposal_template_uuid\": \"3e1437f5-fc22-34b9-88c4-3e3c584b185e\",
\"expire_at\": \"2025-12-08T19:12:42\",
\"tag_uuids\": [
\"d11af7f6-5def-3a23-89fc-48d389dfa8f3\"
]
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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' => '804369f0-754f-3ac0-9893-8791b44b212a',
'customer_uuid' => '7766c640-0f78-30bf-b2c9-0e99c7eb2590',
'customer_address_uuid' => 'a091ba18-1887-38c1-879d-f8f0ca2c17a5',
'status_uuid' => 'f38ef51e-9806-394d-8d91-3b6b7ff60a8c',
'service_plan_uuids' => [
'tempore',
],
'proposal_values' => [],
'proposal_template_uuid' => '3e1437f5-fc22-34b9-88c4-3e3c584b185e',
'expire_at' => '2025-12-08T19:12:42',
'tag_uuids' => [
'd11af7f6-5def-3a23-89fc-48d389dfa8f3',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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": "804369f0-754f-3ac0-9893-8791b44b212a",
"customer_uuid": "7766c640-0f78-30bf-b2c9-0e99c7eb2590",
"customer_address_uuid": "a091ba18-1887-38c1-879d-f8f0ca2c17a5",
"status_uuid": "f38ef51e-9806-394d-8d91-3b6b7ff60a8c",
"service_plan_uuids": [
"tempore"
],
"proposal_values": [],
"proposal_template_uuid": "3e1437f5-fc22-34b9-88c4-3e3c584b185e",
"expire_at": "2025-12-08T19:12:42",
"tag_uuids": [
"d11af7f6-5def-3a23-89fc-48d389dfa8f3"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a proposal activity entry
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1" \
--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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1';
$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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch the specified proposal.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"dolor\",
\"description\": \"Aliquid repellat fuga aut error excepturi veniam accusantium.\",
\"company_location_uuid\": \"be69e6ca-937c-337e-bb45-f444e1ca6cbd\",
\"customer_uuid\": \"37586815-cf49-380f-a334-3317b81b8cb1\",
\"customer_address_uuid\": \"cc00bef4-4c35-321d-b074-b1b4477a76b9\",
\"status_uuid\": \"18338f50-e1b0-385e-a75a-66549153a495\",
\"service_plan_uuids\": [
\"molestiae\"
],
\"proposal_values\": [],
\"proposal_template_uuid\": \"72ee672c-6edb-367e-8c5d-f6b46a8aab42\",
\"expire_at\": \"2025-12-08T19:12:42\",
\"tag_uuids\": [
\"35102012-4b35-3fd5-9cab-72f85ed87985\"
],
\"metadata\": []
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'dolor',
'description' => 'Aliquid repellat fuga aut error excepturi veniam accusantium.',
'company_location_uuid' => 'be69e6ca-937c-337e-bb45-f444e1ca6cbd',
'customer_uuid' => '37586815-cf49-380f-a334-3317b81b8cb1',
'customer_address_uuid' => 'cc00bef4-4c35-321d-b074-b1b4477a76b9',
'status_uuid' => '18338f50-e1b0-385e-a75a-66549153a495',
'service_plan_uuids' => [
'molestiae',
],
'proposal_values' => [],
'proposal_template_uuid' => '72ee672c-6edb-367e-8c5d-f6b46a8aab42',
'expire_at' => '2025-12-08T19:12:42',
'tag_uuids' => [
'35102012-4b35-3fd5-9cab-72f85ed87985',
],
'metadata' => [],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "dolor",
"description": "Aliquid repellat fuga aut error excepturi veniam accusantium.",
"company_location_uuid": "be69e6ca-937c-337e-bb45-f444e1ca6cbd",
"customer_uuid": "37586815-cf49-380f-a334-3317b81b8cb1",
"customer_address_uuid": "cc00bef4-4c35-321d-b074-b1b4477a76b9",
"status_uuid": "18338f50-e1b0-385e-a75a-66549153a495",
"service_plan_uuids": [
"molestiae"
],
"proposal_values": [],
"proposal_template_uuid": "72ee672c-6edb-367e-8c5d-f6b46a8aab42",
"expire_at": "2025-12-08T19:12:42",
"tag_uuids": [
"35102012-4b35-3fd5-9cab-72f85ed87985"
],
"metadata": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Share
requires authentication
Send proposal via email
Delete
requires authentication
Delete a specified proposal.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete Review Photo
requires authentication
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/delete-review-photo" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"image_url\": \"http:\\/\\/armstrong.com\\/consequatur-voluptatem-adipisci-et-labore-unde.html\",
\"type\": \"\'cover\'.\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/delete-review-photo';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'image_url' => 'http://armstrong.com/consequatur-voluptatem-adipisci-et-labore-unde.html',
'type' => '\'cover\'.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/delete-review-photo"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"image_url": "http:\/\/armstrong.com\/consequatur-voluptatem-adipisci-et-labore-unde.html",
"type": "'cover'."
};
fetch(url, {
method: "DELETE",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a proposal activity entry
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/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://staging.api.smarterlaunch.com/api/v1/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6/activity-logs/1"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Referral Source
API for Referral Source
List
requires authentication
Shows the list of referral sources.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single referral source.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created referral source.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"nostrum\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"integration_source_id\": \"1234263\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'nostrum',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "nostrum",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a referral source.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"maxime\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"integration_source_id\": \"1234263\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'maxime',
'description' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
'integration_source_id' => '1234263',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "maxime",
"description": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\"",
"integration_source_id": "1234263"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company referral source.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"a\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"integration_source_id\": \"1234263\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'a',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "a",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a referral source.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-sources/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Report Templates
Create custom report templates with specific data fields, filters, and layouts for recurring business intelligence needs and analytics.
List
requires authentication
Returns the list of available reports
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/reports/templates?page=5&page_size=8&sort_by=illum&sort_order=repudiandae&search=facilis" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/templates';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '5',
'page_size' => '8',
'sort_by' => 'illum',
'sort_order' => 'repudiandae',
'search' => 'facilis',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/reports/templates"
);
const params = {
"page": "5",
"page_size": "8",
"sort_by": "illum",
"sort_order": "repudiandae",
"search": "facilis",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a report template.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/reports/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/reports/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a report template.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/reports/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/reports/templates/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Reports
Generate and export business intelligence reports including sales dashboards, performance metrics, and analytics. Filter reports by user, team, date range, and report type.
List
requires authentication
Returns the list of available reports
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/reports?page=12&page_size=18&sort_by=eum&sort_order=sed&search=nam" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '12',
'page_size' => '18',
'sort_by' => 'eum',
'sort_order' => 'sed',
'search' => 'nam',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/reports"
);
const params = {
"page": "12",
"page_size": "18",
"sort_by": "eum",
"sort_order": "sed",
"search": "nam",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created report.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Duplicate
requires authentication
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.GET api/v1/reports/types
requires authentication
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show admin overview report.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single report.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Export
requires authentication
Export summary reports
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/export" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/export"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Filters
requires authentication
Retrieve filters to be used in frontend processes
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/filters" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6/filters"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/reports/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Reviews
Collect and manage customer reviews and testimonials. Request reviews from satisfied customers to build your online reputation and gather feedback.
List
requires authentication
Shows the list of review with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews?page=16&page_size=11&sort_by=saepe&sort_order=tempore&search=repellendus" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '16',
'page_size' => '11',
'sort_by' => 'saepe',
'sort_order' => 'tempore',
'search' => 'repellendus',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews"
);
const params = {
"page": "16",
"page_size": "11",
"sort_by": "saepe",
"sort_order": "tempore",
"search": "repellendus",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single review.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created review.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=aut"\
--form "message=omnis"\
--form "rate=nostrum"\
--form "external_photo_url=http://www.mertz.com/consequatur-quibusdam-dicta-similique-ipsam-est-quia.html"\
--form "position=17"\
--form "company_location_uuid=534b529e-99c1-35f2-b1a8-d4fc266be5b1"\
--form "photo=@/tmp/phpYqjYWL" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'aut'
],
[
'name' => 'message',
'contents' => 'omnis'
],
[
'name' => 'rate',
'contents' => 'nostrum'
],
[
'name' => 'external_photo_url',
'contents' => 'http://www.mertz.com/consequatur-quibusdam-dicta-similique-ipsam-est-quia.html'
],
[
'name' => 'position',
'contents' => '17'
],
[
'name' => 'company_location_uuid',
'contents' => '534b529e-99c1-35f2-b1a8-d4fc266be5b1'
],
[
'name' => 'photo',
'contents' => fopen('/tmp/phpYqjYWL', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews"
);
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('message', 'omnis');
body.append('rate', 'nostrum');
body.append('external_photo_url', 'http://www.mertz.com/consequatur-quibusdam-dicta-similique-ipsam-est-quia.html');
body.append('position', '17');
body.append('company_location_uuid', '534b529e-99c1-35f2-b1a8-d4fc266be5b1');
body.append('photo', document.querySelector('input[name="photo"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a review.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=architecto"\
--form "message=nihil"\
--form "rate=dolores"\
--form "external_photo_url=http://kirlin.info/voluptatum-iste-quae-ratione-quia-incidunt-soluta.html"\
--form "position=1"\
--form "company_location_uuid=02b59474-2a69-36b6-a959-1d7343953b02"\
--form "photo=@/tmp/php3IQjCJ" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'architecto'
],
[
'name' => 'message',
'contents' => 'nihil'
],
[
'name' => 'rate',
'contents' => 'dolores'
],
[
'name' => 'external_photo_url',
'contents' => 'http://kirlin.info/voluptatum-iste-quae-ratione-quia-incidunt-soluta.html'
],
[
'name' => 'position',
'contents' => '1'
],
[
'name' => 'company_location_uuid',
'contents' => '02b59474-2a69-36b6-a959-1d7343953b02'
],
[
'name' => 'photo',
'contents' => fopen('/tmp/php3IQjCJ', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'architecto');
body.append('message', 'nihil');
body.append('rate', 'dolores');
body.append('external_photo_url', 'http://kirlin.info/voluptatum-iste-quae-ratione-quia-incidunt-soluta.html');
body.append('position', '1');
body.append('company_location_uuid', '02b59474-2a69-36b6-a959-1d7343953b02');
body.append('photo', document.querySelector('input[name="photo"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch Index
requires authentication
Performs specific updates for review ranking
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company review.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"repellendus\",
\"message\": \"quisquam\",
\"rate\": \"laboriosam\",
\"external_photo_url\": \"http:\\/\\/skiles.biz\\/ut-enim-eligendi-asperiores-ipsum-dolor\",
\"position\": 4,
\"company_location_uuid\": \"6750b054-427a-3663-8d7f-1aaa7cb35709\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'repellendus',
'message' => 'quisquam',
'rate' => 'laboriosam',
'external_photo_url' => 'http://skiles.biz/ut-enim-eligendi-asperiores-ipsum-dolor',
'position' => 4,
'company_location_uuid' => '6750b054-427a-3663-8d7f-1aaa7cb35709',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "repellendus",
"message": "quisquam",
"rate": "laboriosam",
"external_photo_url": "http:\/\/skiles.biz\/ut-enim-eligendi-asperiores-ipsum-dolor",
"position": 4,
"company_location_uuid": "6750b054-427a-3663-8d7f-1aaa7cb35709"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a review.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/reviews/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Roles
Define user roles with associated permissions for access control. Uses Spatie Permission package to manage role-based authorization throughout the application.
List / Fetch
requires authentication
Shows the list of role or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List / Fetch
requires authentication
Shows the list of role or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/roles/{roleUuid}" \
--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://staging.api.smarterlaunch.com/api/v1/roles/{roleUuid}';
$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://staging.api.smarterlaunch.com/api/v1/roles/{roleUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create / Update role.
requires authentication
This endpoint lets user to create/update role.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create / Update role.
requires authentication
This endpoint lets user to create/update role.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/roles/{roleUuid}" \
--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://staging.api.smarterlaunch.com/api/v1/roles/{roleUuid}';
$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://staging.api.smarterlaunch.com/api/v1/roles/{roleUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Example request:
curl --request DELETE \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Schedules
Define service and billing frequency schedules (monthly, quarterly, annual, etc.) used in service plans and line items for recurring pest control services.
List
requires authentication
Shows the list of schedule with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules?page=4&page_size=18&sort_by=voluptate&sort_order=et&search=laborum" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '4',
'page_size' => '18',
'sort_by' => 'voluptate',
'sort_order' => 'et',
'search' => 'laborum',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules"
);
const params = {
"page": "4",
"page_size": "18",
"sort_by": "voluptate",
"sort_order": "et",
"search": "laborum",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single schedule.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created schedule.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"esse\",
\"description\": \"Rerum eum est aspernatur odio voluptatibus aut occaecati.\",
\"type\": \"perspiciatis\",
\"units\": 14,
\"term\": \"temporibus\",
\"enabled_service_months\": [
\"eos\"
],
\"visits\": 1
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'esse',
'description' => 'Rerum eum est aspernatur odio voluptatibus aut occaecati.',
'type' => 'perspiciatis',
'units' => 14,
'term' => 'temporibus',
'enabled_service_months' => [
'eos',
],
'visits' => 1,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "esse",
"description": "Rerum eum est aspernatur odio voluptatibus aut occaecati.",
"type": "perspiciatis",
"units": 14,
"term": "temporibus",
"enabled_service_months": [
"eos"
],
"visits": 1
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a schedule.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"cum\",
\"description\": \"Non fuga officiis reprehenderit quae ut.\",
\"type\": \"inventore\",
\"units\": 3,
\"term\": \"qui\",
\"enabled_service_months\": [
\"error\"
],
\"visits\": 17
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'cum',
'description' => 'Non fuga officiis reprehenderit quae ut.',
'type' => 'inventore',
'units' => 3,
'term' => 'qui',
'enabled_service_months' => [
'error',
],
'visits' => 17,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "cum",
"description": "Non fuga officiis reprehenderit quae ut.",
"type": "inventore",
"units": 3,
"term": "qui",
"enabled_service_months": [
"error"
],
"visits": 17
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company schedule.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"sint\",
\"description\": \"Error quam ut mollitia sit quis atque.\",
\"type\": \"neque\",
\"units\": 2,
\"term\": \"facilis\",
\"enabled_service_months\": [
\"aliquam\"
],
\"visits\": 18
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'sint',
'description' => 'Error quam ut mollitia sit quis atque.',
'type' => 'neque',
'units' => 2,
'term' => 'facilis',
'enabled_service_months' => [
'aliquam',
],
'visits' => 18,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "sint",
"description": "Error quam ut mollitia sit quis atque.",
"type": "neque",
"units": 2,
"term": "facilis",
"enabled_service_months": [
"aliquam"
],
"visits": 18
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a schedule.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/schedules/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Service Agreements
Manage legal service agreement templates that outline terms and conditions. Attach service agreements to proposals for customer acceptance and mark agreements as active.
List
requires authentication
Shows the list of company service agreements with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements?page=7&page_size=8&sort_by=eveniet&sort_order=qui&search=deleniti" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '7',
'page_size' => '8',
'sort_by' => 'eveniet',
'sort_order' => 'qui',
'search' => 'deleniti',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements"
);
const params = {
"page": "7",
"page_size": "8",
"sort_by": "eveniet",
"sort_order": "qui",
"search": "deleniti",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single service agreement.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a service agreement.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"est\",
\"content\": \"delectus\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'est',
'content' => 'delectus',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "est",
"content": "delectus"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a service agreement.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"dolorum\",
\"content\": \"deleniti\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'dolorum',
'content' => 'deleniti',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "dolorum",
"content": "deleniti"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a service agreement.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"eos\",
\"content\": \"qui\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'eos',
'content' => 'qui',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "eos",
"content": "qui"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch - Set as Active
requires authentication
Set as Active a service agreement version.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6/setAsActive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"numquam\",
\"content\": \"voluptas\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6/setAsActive';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'numquam',
'content' => 'voluptas',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6/setAsActive"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "numquam",
"content": "voluptas"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a service agreement.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/service-agreements/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Service Plan Custom Fields
Add custom data fields to service plans to capture business-specific information such as treatment methods, coverage areas, or special terms.
List
requires authentication
Shows the list of Service Plan Custom Fields with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields?page=12&page_size=8&sort_by=earum&sort_order=enim&search=qui" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '12',
'page_size' => '8',
'sort_by' => 'earum',
'sort_order' => 'enim',
'search' => 'qui',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields"
);
const params = {
"page": "12",
"page_size": "8",
"sort_by": "earum",
"sort_order": "enim",
"search": "qui",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"custom_fields\": \"s\",
\"save_service_plan_as\": \"SERVICE_PLAN_ACTIVE\",
\"label\": \"First Name\",
\"input_type\": \"TEXT\",
\"default_value\": \"\\\"\\\"\",
\"combine_input_value_collection\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'custom_fields' => 's',
'save_service_plan_as' => 'SERVICE_PLAN_ACTIVE',
'label' => 'First Name',
'input_type' => 'TEXT',
'default_value' => '""',
'combine_input_value_collection' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"custom_fields": "s",
"save_service_plan_as": "SERVICE_PLAN_ACTIVE",
"label": "First Name",
"input_type": "TEXT",
"default_value": "\"\"",
"combine_input_value_collection": true
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get
requires authentication
Display the specified Service Plan Custom Field.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"custom_fields\": \"xfvjwentttathbbalncnoxoa\",
\"save_service_plan_as\": \"SERVICE_PLAN_ACTIVE\",
\"label\": \"First Name\",
\"input_type\": \"TEXT\",
\"default_value\": \"\\\"\\\"\",
\"combine_input_value_collection\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'custom_fields' => 'xfvjwentttathbbalncnoxoa',
'save_service_plan_as' => 'SERVICE_PLAN_ACTIVE',
'label' => 'First Name',
'input_type' => 'TEXT',
'default_value' => '""',
'combine_input_value_collection' => true,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"custom_fields": "xfvjwentttathbbalncnoxoa",
"save_service_plan_as": "SERVICE_PLAN_ACTIVE",
"label": "First Name",
"input_type": "TEXT",
"default_value": "\"\"",
"combine_input_value_collection": true
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Perform patches for the specified Service Plan Custom Field.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Remove the specified Service Plan Custom Field.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-fields/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Service Plan Pricing Groups
Create pricing tiers for service plans based on property size, square footage, treatment frequency, or other factors. Offer multiple pricing options within proposals.
List
requires authentication
Shows the list of Service Plan Pricing Group with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups?page=3&page_size=9&sort_by=ea&sort_order=qui&search=eligendi" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '3',
'page_size' => '9',
'sort_by' => 'ea',
'sort_order' => 'qui',
'search' => 'eligendi',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups"
);
const params = {
"page": "3",
"page_size": "9",
"sort_by": "ea",
"sort_order": "qui",
"search": "eligendi",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Store a newly created Service Plan Pricing Group.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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_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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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_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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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_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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get
requires authentication
Display the specified Service Plan Pricing Group.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Perform patches for the specified Service Plan Pricing Group.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Remove the specified Service Plan Pricing Group.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/pricing-groups/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Service Plans
Define and manage service plan offerings including pricing groups, treatment categories, location availability, service schedules, and contract terms. Service plans can be duplicated and included in proposals.
List
requires authentication
Shows the list of Service Plans with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/service-plans?page=15&page_size=12&sort_by=molestias&sort_order=dolor&search=excepturi" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '15',
'page_size' => '12',
'sort_by' => 'molestias',
'sort_order' => 'dolor',
'search' => 'excepturi',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans"
);
const params = {
"page": "15",
"page_size": "12",
"sort_by": "molestias",
"sort_order": "dolor",
"search": "excepturi",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get
requires authentication
Shows the specified Service Plan.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create
requires authentication
Store a newly created Service Plan.
Example request:
curl --request POST \
"https://staging.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\": \"quo\",
\"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\": 53.790031
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'quo',
'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' => 53.790031,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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": "quo",
"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": 53.790031
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Duplicate
requires authentication
This endpoint lets user to duplicate service plan and set into a draft mode
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/duplicate"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Perform a full field update for the specified Service Plan.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Premium Service Plan\",
\"display_name\": \"et\",
\"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\": 9.139939,
\"save_as\": \"SERVICE_PLAN_ARCHIVED\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Premium Service Plan',
'display_name' => 'et',
'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' => 9.139939,
'save_as' => 'SERVICE_PLAN_ARCHIVED',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Premium Service Plan",
"display_name": "et",
"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": 9.139939,
"save_as": "SERVICE_PLAN_ARCHIVED"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Perform a patch for the specified Service Plan.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Premium Service Plan\",
\"display_name\": \"facilis\",
\"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\": 8010.21811,
\"save_as\": \"SERVICE_PLAN_ARCHIVED\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Premium Service Plan',
'display_name' => 'facilis',
'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' => 8010.21811,
'save_as' => 'SERVICE_PLAN_ARCHIVED',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Premium Service Plan",
"display_name": "facilis",
"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": 8010.21811,
"save_as": "SERVICE_PLAN_ARCHIVED"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Save as Draft
requires authentication
Save as Draft the specified Service Plan.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/draft" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/draft"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Publish
requires authentication
Publish the specified Service Plan.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/publish" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/publish"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Archived
requires authentication
Archived the specified Service Plan.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/archive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/archive"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Unarchived
requires authentication
Unarchived the specified Service Plan.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/unarchive" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6/unarchive"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Remove the specified Service Plan.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/service-plans/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Solution
API for Solution
List
requires authentication
Shows the list of solutions.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single solution.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a new solution.
Example request:
curl --request POST \
"https://staging.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\": \"789f8602-f2b8-39d4-94e9-cfb91b79f7d5\",
\"name\": \"dolor\",
\"slug\": \"solution-1\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"video_url\": \"\\\"https::somevideo.com\\/thevideoforpestroutes\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => '789f8602-f2b8-39d4-94e9-cfb91b79f7d5',
'name' => 'dolor',
'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://staging.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": "789f8602-f2b8-39d4-94e9-cfb91b79f7d5",
"name": "dolor",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store Image
requires authentication
Upload an image to solution
Example request:
curl --request POST \
"https://staging.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/phpi69chM" $client = new \GuzzleHttp\Client();
$url = 'https://staging.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/phpi69chM', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a solution.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"solution_category_uuid\": \"ad923153-b544-38dc-a7cf-2bae52223e68\",
\"name\": \"corrupti\",
\"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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'solution_category_uuid' => 'ad923153-b544-38dc-a7cf-2bae52223e68',
'name' => 'corrupti',
'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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"solution_category_uuid": "ad923153-b544-38dc-a7cf-2bae52223e68",
"name": "corrupti",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Reset
requires authentication
Reset a solution's user progress.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/reset" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/reset"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update user progress
requires authentication
Update user progress.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch Index
requires authentication
Performs specific updates for solutions
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/sort" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/sort"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a solution.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"solution_category_uuid\": \"681e8d62-bf7c-390d-9731-7af9423b3760\",
\"name\": \"aliquid\",
\"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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'solution_category_uuid' => '681e8d62-bf7c-390d-9731-7af9423b3760',
'name' => 'aliquid',
'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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"solution_category_uuid": "681e8d62-bf7c-390d-9731-7af9423b3760",
"name": "aliquid",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a solution.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Solution Category
API for Solution Category
List
requires authentication
Shows the list of solution categories.
Example request:
curl --request GET \
--get "https://staging.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\": [
\"user_progress\"
],
\"ignore_cached\": false
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => [
'user_progress',
],
'ignore_cached' => false,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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": [
"user_progress"
],
"ignore_cached": false
};
fetch(url, {
method: "GET",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single solution category.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a new solution category.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"dolore\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"parent_solution_category_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'dolore',
'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://staging.api.smarterlaunch.com/api/v1/solution-categories"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "dolore",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a solution category.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"quaerat\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"parent_solution_category_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'quaerat',
'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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "quaerat",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Reset
requires authentication
Reset a solution category user progress.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/reset" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/reset"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update user progress
requires authentication
Update user progress.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch Index
requires authentication
Performs specific updates for solution categories
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/sort" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6/sort"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a solution category.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"eveniet\",
\"description\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\",
\"parent_solution_category_uuid\": \"\\\"3c787d66-2a4f-3f1d-9591-c330be0abe82\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'eveniet',
'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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "eveniet",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a solution category.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/solution-categories/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Solution Feedback
API for Solution Feedback
List
requires authentication
Shows the list of solution feedbacks.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single solution.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a new solution feedback.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"rate\": 20,
\"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'rate' => 20,
'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"rate": 20,
"feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a solution .
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"rate\": 18,
\"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'rate' => 18,
'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"rate": 18,
"feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a solution feedback.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"rate\": 1,
\"feedback\": \"\\\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\\\"\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'rate' => 1,
'feedback' => '"Lorem ipsum dolor sit amet consectetur adipisicing elit."',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"rate": 1,
"feedback": "\"Lorem ipsum dolor sit amet consectetur adipisicing elit.\""
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Remove the specified resource from storage.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/solutions/3fa85f64-5717-4562-b3fc-2c963f66afa6/feedback/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.States
Retrieve states/provinces for a given country. Used in address forms and tax rate configuration by geographic region.
List / Fetch
Shows the list of state or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/countries/{countryUuid}/states/{countryStateUuid}" \
--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://staging.api.smarterlaunch.com/api/v1/countries/{countryUuid}/states/{countryStateUuid}';
$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://staging.api.smarterlaunch.com/api/v1/countries/{countryUuid}/states/{countryStateUuid}"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Support Requests
Submit support tickets to Smarter Launch customer service. Attach screenshots and describe issues for technical assistance.
Store
requires authentication
Send support request from users
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Upload
requires authentication
Upload photos for Cover Letter or Photo Layout pages
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/support-request-upload/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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/phpiQ4QLI" \
--form "photo_file=@/tmp/phpOKAn0K" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/support-request-upload/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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/phpiQ4QLI', 'r')
],
[
'name' => 'photo_file',
'contents' => fopen('/tmp/phpOKAn0K', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/support-request-upload/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Symbols
Define diagram symbols and icons used in property maps and treatment diagrams (e.g., bait station icons, treatment area markers). Upload custom symbol images.
List
requires authentication
Shows the list of company symbols with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols?page=20&page_size=12&sort_by=adipisci&sort_order=repudiandae&search=cum" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '20',
'page_size' => '12',
'sort_by' => 'adipisci',
'sort_order' => 'repudiandae',
'search' => 'cum',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols"
);
const params = {
"page": "20",
"page_size": "12",
"sort_by": "adipisci",
"sort_order": "repudiandae",
"search": "cum",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single company symbol.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created company symbol.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=corporis"\
--form "source=asperiores"\
--form "description=Aut dolorem nam dolor."\
--form "icon_url=http://smarterlaunch.local/image1.jpg"\
--form "company_product_uuids[]=laborum"\
--form "icon_file=@/tmp/phpi0PQNK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'corporis'
],
[
'name' => 'source',
'contents' => 'asperiores'
],
[
'name' => 'description',
'contents' => 'Aut dolorem nam dolor.'
],
[
'name' => 'icon_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'company_product_uuids[]',
'contents' => 'laborum'
],
[
'name' => 'icon_file',
'contents' => fopen('/tmp/phpi0PQNK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'corporis');
body.append('source', 'asperiores');
body.append('description', 'Aut dolorem nam dolor.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'laborum');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a company symbol.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=ducimus"\
--form "source=aut"\
--form "description=Explicabo corporis atque asperiores deleniti voluptates dolorem incidunt."\
--form "icon_url=http://smarterlaunch.local/image1.jpg"\
--form "company_product_uuids[]=qui"\
--form "icon_file=@/tmp/php192jIK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'ducimus'
],
[
'name' => 'source',
'contents' => 'aut'
],
[
'name' => 'description',
'contents' => 'Explicabo corporis atque asperiores deleniti voluptates dolorem incidunt.'
],
[
'name' => 'icon_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'company_product_uuids[]',
'contents' => 'qui'
],
[
'name' => 'icon_file',
'contents' => fopen('/tmp/php192jIK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'ducimus');
body.append('source', 'aut');
body.append('description', 'Explicabo corporis atque asperiores deleniti voluptates dolorem incidunt.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'qui');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);
fetch(url, {
method: "PUT",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a company symbol.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=voluptatibus"\
--form "source=at"\
--form "description=Ratione quisquam laudantium vel eos."\
--form "icon_url=http://smarterlaunch.local/image1.jpg"\
--form "company_product_uuids[]=quasi"\
--form "icon_file=@/tmp/phpiTpIXK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'voluptatibus'
],
[
'name' => 'source',
'contents' => 'at'
],
[
'name' => 'description',
'contents' => 'Ratione quisquam laudantium vel eos.'
],
[
'name' => 'icon_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'company_product_uuids[]',
'contents' => 'quasi'
],
[
'name' => 'icon_file',
'contents' => fopen('/tmp/phpiTpIXK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'voluptatibus');
body.append('source', 'at');
body.append('description', 'Ratione quisquam laudantium vel eos.');
body.append('icon_url', 'http://smarterlaunch.local/image1.jpg');
body.append('company_product_uuids[]', 'quasi');
body.append('icon_file', document.querySelector('input[name="icon_file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company symbol.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "name=sed"\
--form "source=molestiae"\
--form "description=Iusto enim doloremque cumque minima."\
--form "icon_url=http://smarterlaunch.local/image1.jpg"\
--form "icon_file=@/tmp/phpoyffZI" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'name',
'contents' => 'sed'
],
[
'name' => 'source',
'contents' => 'molestiae'
],
[
'name' => 'description',
'contents' => 'Iusto enim doloremque cumque minima.'
],
[
'name' => 'icon_url',
'contents' => 'http://smarterlaunch.local/image1.jpg'
],
[
'name' => 'icon_file',
'contents' => fopen('/tmp/phpoyffZI', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('name', 'sed');
body.append('source', 'molestiae');
body.append('description', 'Iusto enim doloremque cumque minima.');
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a company symbol.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/symbols/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Tags
Create custom tags to label and organize customers, proposals, and other records for filtering, searching, and reporting purposes.
List
requires authentication
Shows the list of tags with pagination.
Create
requires authentication
Store a newly created Tag.
Show
requires authentication
Display the specified Tag.
Update
requires authentication
Update the specified Tag.
Delete
requires authentication
Remove the specified Tag.
List Global Tags
requires authentication
Shows the list of global tags (not company-scoped) with pagination. Admins see all global tags, non-admins see only their company's global tags.
Create Global Tag
requires authentication
Store a newly created global Tag (admin/super admin only).
Show Global Tag
requires authentication
Display the specified global Tag.
Update Global Tag
requires authentication
Update the specified global Tag (admin/super admin only).
Delete Global Tag
requires authentication
Remove the specified global Tag (admin/super admin only).
Taxes
Configure sales tax rates for different states, counties, and municipalities. Automatically apply correct tax rates to proposals and invoices based on service address location.
List
requires authentication
Shows the list of taxes with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes?page=16&page_size=11&sort_by=vel&sort_order=aperiam&search=dolores" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '16',
'page_size' => '11',
'sort_by' => 'vel',
'sort_order' => 'aperiam',
'search' => 'dolores',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes"
);
const params = {
"page": "16",
"page_size": "11",
"sort_by": "vel",
"sort_order": "aperiam",
"search": "dolores",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch Index
requires authentication
Performs specific updates for tax settings
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PATCH",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single tax.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created tax.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"country_uuid\": \"8724e1e0-906d-3967-837a-4cca4571e064\",
\"country_state_uuids\": [
\"nisi\"
],
\"name\": \"et\",
\"postal_codes\": 85410,
\"cities\": \"Queen Creek\",
\"rate\": \"12.0000\",
\"is_compound\": true
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'country_uuid' => '8724e1e0-906d-3967-837a-4cca4571e064',
'country_state_uuids' => [
'nisi',
],
'name' => 'et',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"country_uuid": "8724e1e0-906d-3967-837a-4cca4571e064",
"country_state_uuids": [
"nisi"
],
"name": "et",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a tax.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"country_uuid\": \"6503c6fe-b516-3b85-a46c-a6091c51f570\",
\"country_state_uuids\": [
\"necessitatibus\"
],
\"name\": \"modi\",
\"postal_codes\": \"85410\",
\"cities\": \"Queen Creek\",
\"rate\": \"12.0000\",
\"is_compound\": true,
\"rank\": 1
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'country_uuid' => '6503c6fe-b516-3b85-a46c-a6091c51f570',
'country_state_uuids' => [
'necessitatibus',
],
'name' => 'modi',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"country_uuid": "6503c6fe-b516-3b85-a46c-a6091c51f570",
"country_state_uuids": [
"necessitatibus"
],
"name": "modi",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a tax.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"country_uuid\": \"767e2eaa-8701-3eef-9b67-ac0fdd72a660\",
\"country_state_uuids\": [
\"eos\"
],
\"name\": \"eius\",
\"postal_codes\": \"85410\",
\"cities\": \"Queen Creek\",
\"rate\": \"12.0000\",
\"is_compound\": true,
\"rank\": 1
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'country_uuid' => '767e2eaa-8701-3eef-9b67-ac0fdd72a660',
'country_state_uuids' => [
'eos',
],
'name' => 'eius',
'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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"country_uuid": "767e2eaa-8701-3eef-9b67-ac0fdd72a660",
"country_state_uuids": [
"eos"
],
"name": "eius",
"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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a tax.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/taxes/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Teams
Organize users into named teams for filtering and reporting. Team supervisors can view data filtered to their assigned team.
List
requires authentication
Shows the list of teams with pagination.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams?page=17&page_size=17&sort_by=tempore&sort_order=impedit&search=ut" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '17',
'page_size' => '17',
'sort_by' => 'tempore',
'sort_order' => 'impedit',
'search' => 'ut',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams"
);
const params = {
"page": "17",
"page_size": "17",
"sort_by": "tempore",
"sort_order": "impedit",
"search": "ut",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show
requires authentication
Show a single team.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Store a newly created team.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"ut\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'ut',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "ut"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update
requires authentication
Update a team.
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"quas\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'quas',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "quas"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
Patch a company team.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"assumenda\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'assumenda',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "assumenda"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a team.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/companies/3fa85f64-5717-4562-b3fc-2c963f66afa6/teams/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.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://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List / Fetch
requires authentication
Shows the list of users or fetch single record using uuid.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store user profile pic.
requires authentication
This endpoint lets user to upload or update profile picture.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpNY3LpK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpNY3LpK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store user signature pic.
requires authentication
This endpoint lets user to upload or update signature picture.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpyHj9KK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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/phpyHj9KK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create / Update.
requires authentication
This endpoint lets user to create or update single record using uuid
Example request:
curl --request POST \
"https://staging.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/phptQGxOK" $client = new \GuzzleHttp\Client();
$url = 'https://staging.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/phptQGxOK', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create / Update.
requires authentication
This endpoint lets user to create or update single record using uuid
Example request:
curl --request PUT \
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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/phpOieCbM" $client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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/phpOieCbM', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Patch
requires authentication
This endpoint allows users to patch their user info.
Example request:
curl --request PATCH \
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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\": [
\"est\"
],
\"uuid\": \"3245d630-24fd-11ec-accd-e397aec85c7f\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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' => [
'est',
],
'uuid' => '3245d630-24fd-11ec-accd-e397aec85c7f',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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": [
"est"
],
"uuid": "3245d630-24fd-11ec-accd-e397aec85c7f"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove Profile pic.
requires authentication
This endpoint allows users to remove profile pictures with proper authorization.
Example request:
curl --request DELETE \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove Profile pic.
requires authentication
This endpoint allows users to remove profile pictures with proper authorization.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/image" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/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://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6/image"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
This end point allows user to delete the user-account.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--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://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/users/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User Authentication
API for user authentication
Company Registration.
This endpoint lets company owner/manager to register.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Company registration using social account.
This endpoint lets company to register using social account.
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://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User registration using social account based on company invite.
This endpoint lets user to register using social account.
Login.
This endpoint allows common login into the system.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Social Login.
This endpoint lets you login into the system using a 3rd party provider.
Forgot password.
This endpoint lets user to get token to change password.
Example request:
curl --request POST \
"https://staging.api.smarterlaunch.com/api/v1/auth/forgot-password" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"hello@smarterlaunch.com\",
\"token\": \"officiis\"
}"
$client = new \GuzzleHttp\Client();
$url = 'https://staging.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' => 'officiis',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/auth/forgot-password"
);
const headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email": "hello@smarterlaunch.com",
"token": "officiis"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Validate Bearer token.
This endpoint lets user to validate token, on success returns token object.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get Token Expiration This endpoint allows client to retrieve their user token expiration date.
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Verify email.
This endpoint lets the user verify their email and login with token and password.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Resend the email verification notification.
requires authentication
This endpoint lets user to resend email verification notification.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Reset password.
requires authentication
This endpoint lets the user reset their password.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Check token validity.
requires authentication
This endpoint verifies the validity of a reset password token.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get invited user by token
Example request:
curl --request GET \
--get "https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Logout.
requires authentication
let's user to logout.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.User Device Management.
requires authentication
This endpoint lets user to add device information.
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Webhooks
Configure webhook subscriptions to receive real-time HTTP notifications when events occur in Smarter Launch (proposals accepted, documents created, customers added, etc.).
Test
requires authentication
Save new webhook subscription
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List
requires authentication
Shows the list of webhooks.
Example request:
curl --request GET \
--get "https://staging.api.smarterlaunch.com/api/v1/webhooks/subscribe?page=12&page_size=17&sort_by=quasi&sort_order=enim&search=numquam" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/webhooks/subscribe';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'page' => '12',
'page_size' => '17',
'sort_by' => 'quasi',
'sort_order' => 'enim',
'search' => 'numquam',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));const url = new URL(
"https://staging.api.smarterlaunch.com/api/v1/webhooks/subscribe"
);
const params = {
"page": "12",
"page_size": "17",
"sort_by": "quasi",
"sort_order": "enim",
"search": "numquam",
};
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",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Store
requires authentication
Save new webhook subscription
Example request:
curl --request POST \
"https://staging.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://staging.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://staging.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());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete
requires authentication
Delete a webhook.
Example request:
curl --request DELETE \
"https://staging.api.smarterlaunch.com/api/v1/webhooks/subscribe/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"$client = new \GuzzleHttp\Client();
$url = 'https://staging.api.smarterlaunch.com/api/v1/webhooks/subscribe/3fa85f64-5717-4562-b3fc-2c963f66afa6';
$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://staging.api.smarterlaunch.com/api/v1/webhooks/subscribe/3fa85f64-5717-4562-b3fc-2c963f66afa6"
);
const headers = {
"Authorization": "Bearer {YOUR_AUTH_KEY}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.