Swagger\Client\OpportunitiesApi

All URIs are relative to https://api.insightly.com/v3.0

Method	HTTP request	Description
addActivitySetAssignment	POST /Opportunities/{id}/ActivitySetAssignment	Adds an Activity Set to an Opportunity
addEntity	POST /Opportunities	Adds an Opportunity
addFileAttachment	POST /Opportunities/{id}/FileAttachments	Adds a File Attachment to an Opportunity
addFollow	POST /Opportunities/{id}/Follow	Start following an Opportunity
addLink	POST /v3.0/Opportunities/{id}/Links	Adds a Link
addNotes	POST /Opportunities/{id}/Notes	Adds a Note to an Opportunity
addTag	POST /Opportunities/{id}/Tags	Adds a Tag
deleteEntity	DELETE /Opportunities/{id}	Deletes an Opportunity
deleteFollow	DELETE /Opportunities/{id}/Follow	Stop following an Opportunity
deleteImage	DELETE /Opportunities/{id}/Image	Deletes an Opportunity's Image
deleteLink	DELETE /Opportunities/{id}/Links/{linkId}	Deletes a Link
deletePipeline	DELETE /Opportunities/{id}/Pipeline	Clears pipeline for the Opportunity
deleteTag	DELETE /Opportunities/{id}/Tags/{tagName}	Deletes a Tag
getEmails	GET /Opportunities/{id}/Emails	Gets a list of an Opportunity's Emails
getEntities	GET /Opportunities	Gets a list of Opportunities
getEntitiesBySearch	GET /Opportunities/Search	Gets a filtered list of Opportunities
getEntitiesByTag	GET /Opportunities/SearchByTag	Gets a list of Opportunities filtered by tags
getEntity	GET /Opportunities/{id}	Gets an Opportunity
getEvents	GET /Opportunities/{id}/Events	Gets an Opportunity's Events
getFileAttachments	GET /Opportunities/{id}/FileAttachments	Gets an Opportunity's File Attachments
getFollow	GET /Opportunities/{id}/Follow	Gets a Follow state for an Opportunity
getImage	GET /Opportunities/{id}/Image	Gets an Opportunity's Image
getLinkEmailAddress	GET /Opportunities/{id}/LinkEmailAddress	Gets the email address to use for linking with the Opportunity
getLinks	GET /v3.0/Opportunities/{id}/Links	Gets an Opportunity's Links
getNotes	GET /Opportunities/{id}/Notes	Gets an Opportunity's Notes
getStateHistory	GET /Opportunities/{id}/StateHistory	Gets the history of States and Reasons for an Opportunity.
getTasks	GET /Opportunities/{id}/Tasks	Gets a list of an Opportunity's Tasks
updateEntity	PUT /Opportunities	Updates an Opportunity
updateImage	PUT /Opportunities/{id}/Image/{filename}	Updates an Opportunity's Image
updateLink	PUT /v3.0/Opportunities/{id}/Links	Updates a Link
updateNotes	PUT /Opportunities/{id}/Notes	Updates a note of an Opportunity
updateOpportunityState	PUT /Opportunities/{id}/StateChange	Updates an Opportunity State
updatePipeline	PUT /Opportunities/{id}/Pipeline	Changes current pipeline for the Opportunity
updatePipelineStage	PUT /Opportunities/{id}/PipelineStage	Changes current pipeline stage for the Opportunity

addActivitySetAssignment

\Swagger\Client\Model\APIActivitySetAssignment addActivitySetAssignment($id, $authorization, $api_activity_set_assignment)

Adds an Activity Set to an Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\APIActivitySetAssignment(); // \Swagger\Client\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 OpportunitiesApi->addActivitySetAssignment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_activity_set_assignment	\Swagger\Client\Model\APIActivitySetAssignment	The Activity Set Assignment object which contains the configuration information for the Activity Set (just include JSON object as request body)

Return type

\Swagger\Client\Model\APIActivitySetAssignment

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addEntity

\Swagger\Client\Model\Opportunity addEntity($authorization, $field_values)

Adds an Opportunity

If you have trouble with creating an Opportunity, try creating Opportunities via the web interface, and then access those Opportunities via the API. This way you can see examples of the fields and sub-elements attached to the Opportunity. 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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\Opportunity2(); // \Swagger\Client\Model\Opportunity2 | 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 OpportunitiesApi->addEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\Swagger\Client\Model\Opportunity2	The record to add (just include the JSON object as the request body)

Return type

\Swagger\Client\Model\Opportunity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addFileAttachment

\Swagger\Client\Model\APIFileAttachment addFileAttachment($id, $file, $authorization, $file_name, $content_type, $file_category_id)

Adds a File Attachment to an Opportunity

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->addFileAttachment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Swagger\Client\Model\APIFileAttachment

Authorization

No authorization required

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addFollow

\Swagger\Client\Model\APIFollow addFollow($id, $authorization)

Start following an Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->addFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\Swagger\Client\Model\APIFollow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addLink

\Swagger\Client\Model\APILinkDto addLink($id, $authorization, $api_link)

Adds a Link

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\APILinkDto(); // \Swagger\Client\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 OpportunitiesApi->addLink: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]
api_link	\Swagger\Client\Model\APILinkDto	The Link to add (just include JSON object as request body)

Return type

\Swagger\Client\Model\APILinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addNotes

\Swagger\Client\Model\APINote addNotes($id, $authorization, $field_values)

Adds a Note to an Opportunity

If you have trouble with creating an Opportunity, try creating Opportunities via the web interface, and then access those Opportunities via the API. This way you can see examples of the fields and sub-elements attached to the Opportunity. 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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\APINote(); // \Swagger\Client\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 OpportunitiesApi->addNotes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\Swagger\Client\Model\APINote	The record to add (just include the JSON object as the request body)

Return type

\Swagger\Client\Model\APINote

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addTag

\Swagger\Client\Model\APITag addTag($id, $authorization, $api_tag)

Adds a Tag

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\APITag(); // \Swagger\Client\Model\APITag | The Tag to add (just include the JSON object as the request body)

try {
    $result = $apiInstance->addTag($id, $authorization, $api_tag);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->addTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_tag	\Swagger\Client\Model\APITag	The Tag to add (just include the JSON object as the request body)

Return type

\Swagger\Client\Model\APITag

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteEntity

deleteEntity($id, $authorization)

Deletes an Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->deleteEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	Entity's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteFollow

deleteFollow($id, $authorization)

Stop following an Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->deleteFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteImage

deleteImage($id, $authorization)

Deletes an Opportunity's Image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->deleteImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteLink

deleteLink($id, $link_id, $authorization)

Deletes a Link

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->deleteLink: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deletePipeline

deletePipeline($id, $authorization)

Clears pipeline for the Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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->deletePipeline($id, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->deletePipeline: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteTag

deleteTag($id, $tag_name, $authorization)

Deletes a Tag

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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
$tag_name = "tag_name_example"; // string | A Tag's name
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $apiInstance->deleteTag($id, $tag_name, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->deleteTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
tag_name	string	A Tag's name
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEmails

\Swagger\Client\Model\APIEmail[] getEmails($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)

Gets a list of an Opportunity's Emails

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getEmails: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Swagger\Client\Model\APIEmail[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntities

object[] getEntities($authorization, $brief, $skip, $top, $count_total)

Gets a list of Opportunities

Simple object graphs (excluding LINKS, etc.) are returned if "brief=true" is used in the query string.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getEntities: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntitiesBySearch

object[] getEntitiesBySearch($authorization, $field_name, $field_value, $brief, $skip, $top, $count_total)

Gets a filtered list of Opportunities

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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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
$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, $brief, $skip, $top, $count_total);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->getEntitiesBySearch: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntitiesByTag

object[] getEntitiesByTag($tag_name, $authorization, $brief, $skip, $top, $count_total)

Gets a list of Opportunities filtered by tags

Simple object graphs (excluding TAGS, CUSTOMFIELDS, etc.) are returned if "brief=true" is used in the query string.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getEntitiesByTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEntity

\Swagger\Client\Model\Opportunity getEntity($id, $authorization)

Gets an Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	The record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\Swagger\Client\Model\Opportunity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEvents

\Swagger\Client\Model\APIEvent[] getEvents($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)

Gets an Opportunity's Events

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getEvents: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Swagger\Client\Model\APIEvent[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFileAttachments

\Swagger\Client\Model\APIFileAttachment[] getFileAttachments($id, $authorization, $updated_after_utc, $skip, $top, $count_total)

Gets an Opportunity's File Attachments

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getFileAttachments: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Swagger\Client\Model\APIFileAttachment[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getFollow

\Swagger\Client\Model\APIFollow getFollow($id, $authorization)

Gets a Follow state for an Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getFollow: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\Swagger\Client\Model\APIFollow

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getImage

getImage($id, $authorization)

Gets an Opportunity's Image

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLinkEmailAddress

\Swagger\Client\Model\APILinkEmailAddress getLinkEmailAddress($id, $authorization)

Gets the email address to use for linking with the Opportunity

An email address to use as a maildrop for the Opportunity.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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->getLinkEmailAddress($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->getLinkEmailAddress: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\Swagger\Client\Model\APILinkEmailAddress

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLinks

\Swagger\Client\Model\APILinkDto[] getLinks($id, $authorization)

Gets an Opportunity's Links

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getLinks: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\Swagger\Client\Model\APILinkDto[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNotes

\Swagger\Client\Model\APINote[] getNotes($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)

Gets an Opportunity's Notes

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getNotes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Swagger\Client\Model\APINote[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStateHistory

\Swagger\Client\Model\APIOpportunityState[] getStateHistory($id, $authorization)

Gets the history of States and Reasons for an Opportunity.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 | An Opportunity's ID
$authorization = "{{Authorization}}"; // string | Authorization

try {
    $result = $apiInstance->getStateHistory($id, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->getStateHistory: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	An Opportunity's ID
authorization	string	Authorization	[default to {{Authorization}}]

Return type

\Swagger\Client\Model\APIOpportunityState[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTasks

\Swagger\Client\Model\APITask[] getTasks($id, $authorization, $updated_after_utc, $top, $skip, $brief, $count_total)

Gets a list of an Opportunity's Tasks

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->getTasks: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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]

Return type

\Swagger\Client\Model\APITask[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateEntity

\Swagger\Client\Model\Opportunity updateEntity($authorization, $field_values)

Updates an Opportunity

If you have trouble updating an Opportunity, try accessing the Opportunity 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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\Opportunity1(); // \Swagger\Client\Model\Opportunity1 | 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 OpportunitiesApi->updateEntity: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\Swagger\Client\Model\Opportunity1	The record to update (just include the JSON object as the request body)

Return type

\Swagger\Client\Model\Opportunity

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateImage

object[] updateImage($id, $filename, $authorization, $file)

Updates an Opportunity's Image

This action will replace any existing Image attached to the Opportunity. 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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 OpportunitiesApi->updateImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

object[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/octet-stream
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateLink

\Swagger\Client\Model\APILinkDto updateLink($id, $authorization, $api_link)

Updates a Link

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\APILinkDto(); // \Swagger\Client\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 OpportunitiesApi->updateLink: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]
api_link	\Swagger\Client\Model\APILinkDto	The Link to add (just include JSON object as request body)

Return type

\Swagger\Client\Model\APILinkDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateNotes

\Swagger\Client\Model\APINote updateNotes($id, $authorization, $field_values, $brief)

Updates a note of an Opportunity

If you have trouble updating an Opportunity, try accessing the Opportunity 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.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 \Swagger\Client\Model\APINote(); // \Swagger\Client\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 OpportunitiesApi->updateNotes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID (RECORD_ID)
authorization	string	Authorization	[default to {{Authorization}}]
field_values	\Swagger\Client\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]

Return type

\Swagger\Client\Model\APINote

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateOpportunityState

\Swagger\Client\Model\APIOpportunityState updateOpportunityState($id, $authorization, $api_opportunity_state)

Updates an Opportunity State

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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 | Opportunitie's ID
$authorization = "{{Authorization}}"; // string | Authorization
$api_opportunity_state = new \Swagger\Client\Model\APIOpportunityState(); // \Swagger\Client\Model\APIOpportunityState | A Opportunity State (just include JSON object as request body)

try {
    $result = $apiInstance->updateOpportunityState($id, $authorization, $api_opportunity_state);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->updateOpportunityState: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	Opportunitie's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_opportunity_state	\Swagger\Client\Model\APIOpportunityState	A Opportunity State (just include JSON object as request body)

Return type

\Swagger\Client\Model\APIOpportunityState

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePipeline

\Swagger\Client\Model\APIPipelineChange[] updatePipeline($id, $authorization, $api_pipeline_change)

Changes current pipeline for the Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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_pipeline_change = new \Swagger\Client\Model\APIPipelineChange(); // \Swagger\Client\Model\APIPipelineChange | Pipeline change parameters (just include JSON object as request body)

try {
    $result = $apiInstance->updatePipeline($id, $authorization, $api_pipeline_change);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->updatePipeline: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_pipeline_change	\Swagger\Client\Model\APIPipelineChange	Pipeline change parameters (just include JSON object as request body)

Return type

\Swagger\Client\Model\APIPipelineChange[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePipelineStage

\Swagger\Client\Model\APIPipelineChange[] updatePipelineStage($id, $authorization, $api_stage_change)

Changes current pipeline stage for the Opportunity

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Swagger\Client\Api\OpportunitiesApi(
    // 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_stage_change = new \Swagger\Client\Model\APIPipelineChange(); // \Swagger\Client\Model\APIPipelineChange | Pipeline stage change parameters (just include JSON object as request body)

try {
    $result = $apiInstance->updatePipelineStage($id, $authorization, $api_stage_change);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OpportunitiesApi->updatePipelineStage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	A Record's ID
authorization	string	Authorization	[default to {{Authorization}}]
api_stage_change	\Swagger\Client\Model\APIPipelineChange	Pipeline stage change parameters (just include JSON object as request body)

Return type

\Swagger\Client\Model\APIPipelineChange[]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OpportunitiesApi.md

Latest commit

History

OpportunitiesApi.md

File metadata and controls

Swagger\Client\OpportunitiesApi

addActivitySetAssignment

Example

Parameters

Return type

Authorization

HTTP request headers

addEntity

Example

Parameters

Return type

Authorization

HTTP request headers

addFileAttachment

Example

Parameters

Return type

Authorization

HTTP request headers

addFollow

Example

Parameters

Return type

Authorization

HTTP request headers

addLink

Example

Parameters

Return type

Authorization

HTTP request headers

addNotes

Example

Parameters

Return type

Authorization

HTTP request headers

addTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteEntity

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFollow

Example

Parameters

Return type

Authorization

HTTP request headers

deleteImage

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLink

Example

Parameters

Return type

Authorization

HTTP request headers

deletePipeline

Example

Parameters

Return type

Authorization

HTTP request headers

deleteTag