All URIs are relative to https://api.insightly.com/v3.1
| Method | HTTP request | Description |
|---|---|---|
| addActivitySetAssignment | POST /Contacts/{id}/ActivitySetAssignment | Adds an Activity Set to a Contact |
| addEntity | POST /Contacts | Adds a Contact |
| addFileAttachment | POST /Contacts/{id}/FileAttachments | Adds a File Attachment to a Contact |
| addFollow | POST /Contacts/{id}/Follow | Start following a Contact |
| addLink | POST /Contacts/{id}/Links | Adds a Link |
| addNotes | POST /Contacts/{id}/Notes | Adds a Note to a Contact |
| addTag | POST /Contacts/{id}/Tags | Adds a Tag to a Contact |
| deleteEntity | DELETE /Contacts/{id} | Deletes a Contact |
| deleteFollow | DELETE /Contacts/{id}/Follow | Stop following a Contact |
| deleteImage | DELETE /Contacts/{id}/Image | Deletes a Contact's Image |
| deleteImageField | DELETE /Contacts/{id}/ImageField/{fieldName} | Deletes a Contact's Custom Image Field |
| deleteLink | DELETE /Contacts/{id}/Links/{linkId} | Deletes a Link |
| deleteTag | DELETE /Contacts/{id}/Tags | Deletes a Tag from a Contact |
| getDates | GET /Contacts/{id}/Dates | Gets a Contact's Dates |
| getEmails | GET /Contacts/{id}/Emails | Gets a list of a Contact's Emails |
| getEntities | GET /Contacts | Gets a list of Contacts |
| getEntitiesBySearch | GET /Contacts/Search | Gets a filtered list of Contacts |
| getEntitiesByTag | GET /Contacts/SearchByTag | Gets a list of Contacts filtered by tags |
| getEntity | GET /Contacts/{id} | Gets a Contact |
| getEvents | GET /Contacts/{id}/Events | Gets a Contact's Events |
| getFileAttachments | GET /Contacts/{id}/FileAttachments | Gets a Contact's File Attachments |
| getFollow | GET /Contacts/{id}/Follow | Gets a Follow state for a Contact |
| getImage | GET /Contacts/{id}/Image | Gets a Contact's Image |
| getImageField | GET /Contacts/{id}/ImageField/{fieldName} | Gets a Contact's Custom Image Field |
| getLinks | GET /Contacts/{id}/Links | Gets a Contact's Links |
| getNotes | GET /Contacts/{id}/Notes | Gets a Contact's Notes |
| getTags | GET /Contacts/{id}/Tags | Gets a Contact's Tags |
| getTasks | GET /Contacts/{id}/Tasks | Gets a list of a Contact's Tasks |
| updateDates | PUT /Contacts/{id}/Dates | Updates a Contact's Dates |
| updateEntity | PUT /Contacts | Updates a Contact |
| updateImage | PUT /Contacts/{id}/Image/{filename} | Updates a Contact's Image |
| updateImageField | PUT /Contacts/{id}/ImageField/{fieldName}/{fileName} | Updates a Contact's Custom Image Field |
| updateLink | PUT /Contacts/{id}/Links | Updates a Link |
| updateNotes | PUT /Contacts/{id}/Notes | Updates a note of a Contact |
| updateTags | PUT /Contacts/{id}/Tags | Updates a Contact's Tags |
\SternerStuff\InsightlyPHP\Model\APIActivitySetAssignment addActivitySetAssignment($id, $authorization, $api_activity_set_assignment)
Adds an Activity Set to a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
$api_activity_set_assignment = new \SternerStuff\InsightlyPHP\Model\APIActivitySetAssignment(); // \SternerStuff\InsightlyPHP\Model\APIActivitySetAssignment | The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body)
try {
$result = $apiInstance->addActivitySetAssignment($id, $authorization, $api_activity_set_assignment);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addActivitySetAssignment: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_activity_set_assignment | \SternerStuff\InsightlyPHP\Model\APIActivitySetAssignment | The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body) |
\SternerStuff\InsightlyPHP\Model\APIActivitySetAssignment
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 addEntity($authorization, $field_values)
Adds a Contact
If you have trouble with creating a Contact, try creating Contacts via the web interface, and then access those Contacts via the API. This way you can see examples of the fields and sub-elements attached to the Contact. 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\ContactsApi(
// 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 ContactsApi->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\APIFileAttachment addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id)
Adds a File Attachment to a Contact
This endpoint expects multipart/form-data as the request payload. See Stack Overflow for examples of how to generate multipart requests, or see our <a href="http://github.com/Insightly\" target="_blank">client libraries for an example of how this is generated. Only one file can be added per request.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 | Record ID
$file = "/path/to/file.txt"; // \SplFileObject | The file part of the multipart/form-data request. Only one file can be added per request.
$authorization = "{{Authorization}}"; // string | Authorization
$file_name = "file_name_example"; // string |
$content_type = "content_type_example"; // string |
$file_category_id = 56; // int |
try {
$result = $apiInstance->addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addFileAttachment: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | Record ID | |
| file | \SplFileObject | The file part of the multipart/form-data request. Only one file can be added per request. | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| file_name | string | [optional] | |
| content_type | string | [optional] | |
| file_category_id | int | [optional] |
\SternerStuff\InsightlyPHP\Model\APIFileAttachment
No authorization required
- Content-Type: multipart/form-data
- 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 Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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\APILinkDto addLink($id, $authorization, $api_link)
Adds a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$api_link = new \SternerStuff\InsightlyPHP\Model\APILinkDto(); // \SternerStuff\InsightlyPHP\Model\APILinkDto | The Link to add (just include JSON object as request body)
try {
$result = $apiInstance->addLink($id, $authorization, $api_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_link | \SternerStuff\InsightlyPHP\Model\APILinkDto | The Link to add (just include JSON object as request body) |
\SternerStuff\InsightlyPHP\Model\APILinkDto
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\APINote addNotes($id, $authorization, $field_values)
Adds a Note to a Contact
If you have trouble with creating a Contact, try creating Contacts via the web interface, and then access those Contacts via the API. This way you can see examples of the fields and sub-elements attached to the Contact. 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\ContactsApi(
// 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
$field_values = new \SternerStuff\InsightlyPHP\Model\APINote(); // \SternerStuff\InsightlyPHP\Model\APINote | The record to add (just include the JSON object as the request body)
try {
$result = $apiInstance->addNotes($id, $authorization, $field_values);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->addNotes: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \SternerStuff\InsightlyPHP\Model\APINote | The record to add (just include the JSON object as the request body) |
\SternerStuff\InsightlyPHP\Model\APINote
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 Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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 Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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 Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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]
deleteImage($id, $authorization)
Deletes a Contact's Image
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteImage($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteImage: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record'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]
deleteImageField($id, $field_name, $authorization)
Deletes a Contact's Custom Image Field
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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]
deleteLink($id, $link_id, $authorization)
Deletes a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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)
$link_id = 789; // int | A Link's ID (LINK_ID)
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->deleteLink($id, $link_id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->deleteLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| link_id | int | A Link's ID (LINK_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]
deleteTag($id, $api_tag, $authorization)
Deletes a Tag from a Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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]
\SternerStuff\InsightlyPHP\Model\APIDate[] getDates($id, $authorization)
Gets a Contact's Dates
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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->getDates($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getDates: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | The record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\SternerStuff\InsightlyPHP\Model\APIDate[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\SternerStuff\InsightlyPHP\Model\APIEmail[] getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a list of a Contact's Emails
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when email was last updated.
$top = 56; // int | Optional, maximum number of emails to return.
$skip = 56; // int | Optional, number of emails to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEmails: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when email was last updated. | [optional] |
| top | int | Optional, maximum number of emails to return. | [optional] |
| skip | int | Optional, number of emails to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\SternerStuff\InsightlyPHP\Model\APIEmail[]
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[] getEntities($authorization, $brief, $skip, $top, $count_total)
Gets a list of Contacts
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\ContactsApi(
// 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 ContactsApi->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 Contacts
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\ContactsApi(
// 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 ContactsApi->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 Contacts 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\ContactsApi(
// 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 ContactsApi->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 Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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\APIEvent[] getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a Contact's Events
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when event was last updated.
$top = 56; // int | Optional, maximum number of events to return.
$skip = 56; // int | Optional, number of events to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getEvents: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when event was last updated. | [optional] |
| top | int | Optional, maximum number of events to return. | [optional] |
| skip | int | Optional, number of events to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\SternerStuff\InsightlyPHP\Model\APIEvent[]
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\APIFileAttachment[] getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total)
Gets a Contact's File Attachments
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when file attachment was last updated.
$skip = 56; // int | Optional, number of file attachments to skip.
$top = 56; // int | Optional, maximum number of file attachments to return in the response.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getFileAttachments: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when file attachment was last updated. | [optional] |
| skip | int | Optional, number of file attachments to skip. | [optional] |
| top | int | Optional, maximum number of file attachments to return in the response. | [optional] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\SternerStuff\InsightlyPHP\Model\APIFileAttachment[]
No authorization required
- Content-Type: application/json
- Accept: 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 Contact
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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]
getImage($id, $authorization)
Gets a Contact's Image
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
try {
$apiInstance->getImage($id, $authorization);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getImage: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| 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]
getImageField($id, $field_name, $authorization)
Gets a Contact's Custom Image Field
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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\APILinkDto[] getLinks($id, $authorization)
Gets a Contact's Links
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
try {
$result = $apiInstance->getLinks($id, $authorization);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getLinks: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
\SternerStuff\InsightlyPHP\Model\APILinkDto[]
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\APINote[] getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a Contact's Notes
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when note was last updated.
$top = 56; // int | Optional, maximum number of notes to return.
$skip = 56; // int | Optional, number of notes to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getNotes: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when note was last updated. | [optional] |
| top | int | Optional, maximum number of notes to return. | [optional] |
| skip | int | Optional, number of notes to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\SternerStuff\InsightlyPHP\Model\APINote[]
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 Contact's Tags
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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]
\SternerStuff\InsightlyPHP\Model\APITask[] getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)
Gets a list of a Contact's Tasks
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
$updated_after_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Optional, earliest date when task was last updated.
$top = 56; // int | Optional, maximum number of tasks to return.
$skip = 56; // int | Optional, number of tasks to skip.
$brief = false; // bool | true if only top level properties needs to be returned.
$count_total = false; // bool | true if total number of records should be returned in the response headers.
try {
$result = $apiInstance->getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->getTasks: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| updated_after_utc | \DateTime | Optional, earliest date when task was last updated. | [optional] |
| top | int | Optional, maximum number of tasks to return. | [optional] |
| skip | int | Optional, number of tasks to skip. | [optional] |
| brief | bool | true if only top level properties needs to be returned. | [optional] [default to false] |
| count_total | bool | true if total number of records should be returned in the response headers. | [optional] [default to false] |
\SternerStuff\InsightlyPHP\Model\APITask[]
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\APIDate[] updateDates($id, $authorization, $api_dates)
Updates a Contact's Dates
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$authorization = "{{Authorization}}"; // string | Authorization
$api_dates = new \SternerStuff\InsightlyPHP\Model\APIDate(); // \SternerStuff\InsightlyPHP\Model\APIDate | The Date collection to update
try {
$result = $apiInstance->updateDates($id, $authorization, $api_dates);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateDates: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_dates | \SternerStuff\InsightlyPHP\Model\APIDate | The Date collection to update |
\SternerStuff\InsightlyPHP\Model\APIDate[]
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 updateEntity($authorization, $field_values)
Updates a Contact
If you have trouble updating a Contact, try accessing the Contact 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\ContactsApi(
// 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 ContactsApi->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[] updateImage($id, $filename, $authorization, $file)
Updates a Contact's Image
This action will replace any existing Image attached to the Contact. 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\ContactsApi(
// 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
$filename = "filename_example"; // string | Name of Image File to be attached to Record
$authorization = "{{Authorization}}"; // string | Authorization
$file = "B"; // string | File to upload
try {
$result = $apiInstance->updateImage($id, $filename, $authorization, $file);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateImage: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID | |
| filename | string | Name of Image File to be attached to Record | |
| 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]
object[] updateImageField($id, $field_name, $file_name, $authorization, $file)
Updates a Contact's Custom Image Field
This action will replace any existing Image attached to the Contact'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\ContactsApi(
// 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 ContactsApi->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\APILinkDto updateLink($id, $authorization, $api_link)
Updates a Link
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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
$api_link = new \SternerStuff\InsightlyPHP\Model\APILinkDto(); // \SternerStuff\InsightlyPHP\Model\APILinkDto | The Link to add (just include JSON object as request body)
try {
$result = $apiInstance->updateLink($id, $authorization, $api_link);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateLink: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| api_link | \SternerStuff\InsightlyPHP\Model\APILinkDto | The Link to add (just include JSON object as request body) |
\SternerStuff\InsightlyPHP\Model\APILinkDto
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\APINote updateNotes($id, $authorization, $field_values, $brief)
Updates a note of a Contact
If you have trouble updating a Contact, try accessing the Contact 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\ContactsApi(
// 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
$field_values = new \SternerStuff\InsightlyPHP\Model\APINote(); // \SternerStuff\InsightlyPHP\Model\APINote | The record to update (just include the JSON object as the request body)
$brief = false; // bool | Optional, true if response should only contain top level properties of the record.
try {
$result = $apiInstance->updateNotes($id, $authorization, $field_values, $brief);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContactsApi->updateNotes: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| id | int | A Record's ID (RECORD_ID) | |
| authorization | string | Authorization | [default to {{Authorization}}] |
| field_values | \SternerStuff\InsightlyPHP\Model\APINote | The record to update (just include the JSON object as the request body) | |
| brief | bool | Optional, true if response should only contain top level properties of the record. | [optional] [default to false] |
\SternerStuff\InsightlyPHP\Model\APINote
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[] updateTags($id, $authorization, $api_tag)
Updates a Contact's Tags
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new SternerStuff\InsightlyPHP\Api\ContactsApi(
// 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 ContactsApi->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]