All URIs are relative to https://api.insightly.com/v3.1
| Method | HTTP request | Description |
|---|---|---|
| addEntity | POST /Prospect | Adds a Prospect |
| addFollow | POST /Prospect/{id}/Follow | Start following a Prospect |
| addTag | POST /Prospect/{id}/Tags | Adds a Tag to a Prospect |
| deleteEntity | DELETE /Prospect/{id} | Deletes a Prospect |
| deleteFollow | DELETE /Prospect/{id}/Follow | Stop following a Prospect |
| deleteImageField | DELETE /Prospect/{id}/ImageField/{fieldName} | Deletes a Prospect's Custom Image Field |
| deleteTag | DELETE /Prospect/{id}/Tags | Deletes a Tag from a Prospect |
| getEntities | GET /Prospect | Gets a list of Prospects |
| getEntitiesBySearch | GET /Prospect/Search | Gets a filtered list of Prospects |
| getEntitiesByTag | GET /Prospect/SearchByTag | Gets a list of Prospects filtered by tags |
| getEntity | GET /Prospect/{id} | Gets a Prospect |
| getFollow | GET /Prospect/{id}/Follow | Gets a Follow state for a Prospect |
| getImageField | GET /Prospect/{id}/ImageField/{fieldName} | Gets a Prospect's Custom Image Field |
| getTags | GET /Prospect/{id}/Tags | Gets a Prospect's Tags |
| updateEntity | PUT /Prospect | Updates a Prospect |
| updateImageField | PUT /Prospect/{id}/ImageField/{fieldName}/{fileName} | Updates a Prospect's Custom Image Field |
| updateTags | PUT /Prospect/{id}/Tags | Updates a Prospect's Tags |
object addEntity($authorization, $field_values)
Adds a Prospect
If you have trouble with creating a Prospect, try creating Prospects via the web interface, and then access those Prospects via the API. This way you can see examples of the fields and sub-elements attached to the Prospect. A common source of problems during write/update request is caused when users omit required fields, or insert invalid data in a field (e.g. reference a CATEGORY_ID that does not exist in the user's Insightly instance.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addEntity($authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->addEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \SternerStuff\InsightlyPHP\Model\FieldValues | The record to add (just include the JSON object as the request body) |
object
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SternerStuff\InsightlyPHP\Model\APIFollow addFollow($id, $authorization)
Start following a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->addFollow($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->addFollow: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\SternerStuff\InsightlyPHP\Model\APIFollow
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SternerStuff\InsightlyPHP\Model\APITag addTag($id, $authorization, $api_tag)
Adds a Tag to a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_tag = new \SternerStuff\InsightlyPHP\Model\APITag(); // \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tag
try {
$result = $apiInstance->addTag($id, $authorization, $api_tag);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->addTag: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_tag | \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tag |
\SternerStuff\InsightlyPHP\Model\APITag
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteEntity($id, $authorization)
Deletes a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | Entity's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteEntity($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->deleteEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Entity's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteFollow($id, $authorization)
Stop following a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteFollow($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->deleteFollow: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteImageField($id, $field_name, $authorization)
Deletes a Prospect's Custom Image Field
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteImageField($id, $field_name, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->deleteImageField: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| field_name | string | An image field name | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
deleteTag($id, $api_tag, $authorization)
Deletes a Tag from a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$api_tag = new \SternerStuff\InsightlyPHP\Model\APITag(); // \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tag
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteTag($id, $api_tag, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| api_tag | \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tag | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntities($authorization, $brief, $skip, $top, $count_total)
Gets a list of Prospects
Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional,true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEntities($authorization, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
| skip | int | Optional, number of records to skip. | [optional] |
| top | int | Optional, maximum number of records to return in the response. | [optional] |
| count_total | bool | Optional,true if total number of records should be returned in the response headers. | [optional] [default to false] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total)
Gets a filtered list of Prospects
To filter with a field name and value, both field_name and field_value parameters must be provided.
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_name = "field_name_example"; // string | Optional, field name for object
$field_value = "field_value_example"; // string | Optional, field value of the record
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when a record was last updated.
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEntitiesBySearch($authorization, $field_name, $field_value, $updated_after_utc, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_name | string | Optional, field name for object | [optional] |
| field_value | string | Optional, field value of the record | [optional] |
| updated_after_utc | \DateTime | Optional, earliest date when a record was last updated. | [optional] |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
| skip | int | Optional, number of records to skip. | [optional] |
| top | int | Optional, maximum number of records to return in the response. | [optional] |
| count_total | bool | Optional, true if total number of records should be returned in the response headers. | [optional] [default to false] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total)
Gets a list of Prospects filtered by tags
Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$tag_name = "tag_name_example"; // string | Tag name to filter on
$authorization = "{{Authorization}}"; // string | Authorization
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
$skip = 56; // int | Optional, number of records to skip.
$top = 56; // int | Optional, maximum number of records to return in the response.
$count_total = false; // bool | Optional, true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getEntitiesByTag: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| tag_name | string | Tag name to filter on | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
| skip | int | Optional, number of records to skip. | [optional] |
| top | int | Optional, maximum number of records to return in the response. | [optional] |
| count_total | bool | Optional, true if total number of records should be returned in the response headers. | [optional] [default to false] |
object[]
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object getEntity($id, $authorization)
Gets a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getEntity($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
object
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SternerStuff\InsightlyPHP\Model\APIFollow getFollow($id, $authorization)
Gets a Follow state for a Prospect
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A record's ID (RECORD_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getFollow($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getFollow: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\SternerStuff\InsightlyPHP\Model\APIFollow
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getImageField($id, $field_name, $authorization)
Gets a Prospect's Custom Image Field
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->getImageField($id, $field_name, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getImageField: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| field_name | string | An image field name | |
| authorization | string | Authorization | [default to {{Authorization}}] |
void (empty response body)
No authorization required
- Content-Type: application/json
- Accept: application/octet-stream, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SternerStuff\InsightlyPHP\Model\APITag[] getTags($id, $authorization)
Gets a Prospect's Tags
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getTags($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->getTags: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\SternerStuff\InsightlyPHP\Model\APITag[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object updateEntity($authorization, $field_values)
Updates a Prospect
If you have trouble updating a Prospect, try accessing the Prospect via the GET request to inspect its fields and sub-elements. A common source of problems with write/update requests occurs when users either omit required fields, or insert invalid data into a field (for example, by referring a CATEGORY_ID or LINK_ID which does not exist.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$authorization = "{{Authorization}}"; // string | Authorization
$field_values = new \SternerStuff\InsightlyPHP\Model\\SternerStuff\InsightlyPHP\Model\FieldValues(); // \SternerStuff\InsightlyPHP\Model\FieldValues | The record to update (just include the JSON object as the request body)
try {
$result = $apiInstance->updateEntity($authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->updateEntity: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \SternerStuff\InsightlyPHP\Model\FieldValues | The record to update (just include the JSON object as the request body) |
object
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
object[] updateImageField($id, $field_name, $file_name, $authorization, $file)
Updates a Prospect's Custom Image Field
This action will replace any existing Image attached to the Prospect's image field. The contents of the image data should be sent as binary data in the request payload. See our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is done.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | A Record's ID
$field_name = "field_name_example"; // string | An image field name
$file_name = "file_name_example"; // string | An image file name
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload
try {
$result = $apiInstance->updateImageField($id, $field_name, $file_name, $authorization, $file);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->updateImageField: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| field_name | string | An image field name | |
| file_name | string | An image file name | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| file | string | File to upload |
object[]
No authorization required
- Content-Type: application/octet-stream
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SternerStuff\InsightlyPHP\Model\APITag[] updateTags($id, $authorization, $api_tag)
Updates a Prospect's Tags
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ProspectsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$id = 789; // int | The record's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_tag = new \SternerStuff\InsightlyPHP\Model\APITag(); // \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tags
try {
$result = $apiInstance->updateTags($id, $authorization, $api_tag);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ProspectsApi->updateTags: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_tag | \SternerStuff\InsightlyPHP\Model\APITag | The Record's Tags |
\SternerStuff\InsightlyPHP\Model\APITag[]
No authorization required
- Content-Type: application/json
- Accept: application/json, text/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]