HubSpot.NET.Api.BasicApi

All URIs are relative to https://api.hubapi.com

Method	HTTP request	Description
DeleteCrmV3ObjectsCompaniesCompanyIdArchive	DELETE /crm/v3/objects/companies/{companyId}	Archive
DeleteCrmV3ObjectsContactsContactIdArchive	DELETE /crm/v3/objects/contacts/{contactId}	Archive
DeleteCrmV3ObjectsDealsDealIdArchive	DELETE /crm/v3/objects/deals/{dealId}	Archive
DeleteCrmV3ObjectsLineItemsLineItemIdArchive	DELETE /crm/v3/objects/line_items/{lineItemId}	Archive
DeleteCrmV3ObjectsObjectTypeObjectIdArchive	DELETE /crm/v3/objects/{objectType}/{objectId}	Archive
DeleteCrmV3ObjectsProductsProductIdArchive	DELETE /crm/v3/objects/products/{productId}	Archive
DeleteCrmV3ObjectsTicketsTicketIdArchive	DELETE /crm/v3/objects/tickets/{ticketId}	Archive
DeleteMarketingV3MarketingEventsEventsExternalEventId	DELETE /marketing/v3/marketing-events/events/{externalEventId}	Delete a marketing event
GetCrmV3ObjectsCompaniesCompanyIdGetById	GET /crm/v3/objects/companies/{companyId}	Read
GetCrmV3ObjectsCompaniesGetPage	GET /crm/v3/objects/companies	List
GetCrmV3ObjectsContactsContactIdGetById	GET /crm/v3/objects/contacts/{contactId}	Read
GetCrmV3ObjectsContactsGetPage	GET /crm/v3/objects/contacts	List
GetCrmV3ObjectsDealsDealIdGetById	GET /crm/v3/objects/deals/{dealId}	Read
GetCrmV3ObjectsDealsGetPage	GET /crm/v3/objects/deals	List
GetCrmV3ObjectsFeedbackSubmissionsFeedbackSubmissionIdGetById	GET /crm/v3/objects/feedback_submissions/{feedbackSubmissionId}	Read
GetCrmV3ObjectsFeedbackSubmissionsGetPage	GET /crm/v3/objects/feedback_submissions	List
GetCrmV3ObjectsLineItemsGetPage	GET /crm/v3/objects/line_items	List
GetCrmV3ObjectsLineItemsLineItemIdGetById	GET /crm/v3/objects/line_items/{lineItemId}	Read
GetCrmV3ObjectsObjectTypeGetPage	GET /crm/v3/objects/{objectType}	List
GetCrmV3ObjectsObjectTypeObjectIdGetById	GET /crm/v3/objects/{objectType}/{objectId}	Read
GetCrmV3ObjectsProductsGetPage	GET /crm/v3/objects/products	List
GetCrmV3ObjectsProductsProductIdGetById	GET /crm/v3/objects/products/{productId}	Read
GetCrmV3ObjectsQuotesGetPage	GET /crm/v3/objects/quotes	List
GetCrmV3ObjectsQuotesQuoteIdGetById	GET /crm/v3/objects/quotes/{quoteId}	Read
GetCrmV3ObjectsTicketsGetPage	GET /crm/v3/objects/tickets	List
GetCrmV3ObjectsTicketsTicketIdGetById	GET /crm/v3/objects/tickets/{ticketId}	Read
GetMarketingV3MarketingEventsEventsExternalEventId	GET /marketing/v3/marketing-events/events/{externalEventId}	Get a marketing event
PatchCrmV3ObjectsCompaniesCompanyIdUpdate	PATCH /crm/v3/objects/companies/{companyId}	Update
PatchCrmV3ObjectsContactsContactIdUpdate	PATCH /crm/v3/objects/contacts/{contactId}	Update
PatchCrmV3ObjectsDealsDealIdUpdate	PATCH /crm/v3/objects/deals/{dealId}	Update
PatchCrmV3ObjectsLineItemsLineItemIdUpdate	PATCH /crm/v3/objects/line_items/{lineItemId}	Update
PatchCrmV3ObjectsObjectTypeObjectIdUpdate	PATCH /crm/v3/objects/{objectType}/{objectId}	Update
PatchCrmV3ObjectsProductsProductIdUpdate	PATCH /crm/v3/objects/products/{productId}	Update
PatchCrmV3ObjectsTicketsTicketIdUpdate	PATCH /crm/v3/objects/tickets/{ticketId}	Update
PatchMarketingV3MarketingEventsEventsExternalEventId	PATCH /marketing/v3/marketing-events/events/{externalEventId}	Update a marketing event
PostCrmV3ObjectsCompaniesCreate	POST /crm/v3/objects/companies	Create
PostCrmV3ObjectsContactsCreate	POST /crm/v3/objects/contacts	Create
PostCrmV3ObjectsDealsCreate	POST /crm/v3/objects/deals	Create
PostCrmV3ObjectsLineItemsCreate	POST /crm/v3/objects/line_items	Create
PostCrmV3ObjectsObjectTypeCreate	POST /crm/v3/objects/{objectType}	Create
PostCrmV3ObjectsProductsCreate	POST /crm/v3/objects/products	Create
PostCrmV3ObjectsTicketsCreate	POST /crm/v3/objects/tickets	Create
PostMarketingV3MarketingEventsEvents	POST /marketing/v3/marketing-events/events	Create a marketing event
PostMarketingV3MarketingEventsEventsExternalEventIdCancel	POST /marketing/v3/marketing-events/events/{externalEventId}/cancel	Mark a marketing event as cancelled
PutMarketingV3MarketingEventsEventsExternalEventId	PUT /marketing/v3/marketing-events/events/{externalEventId}	Create or update a marketing event

DeleteCrmV3ObjectsCompaniesCompanyIdArchive

void DeleteCrmV3ObjectsCompaniesCompanyIdArchive (string companyId)

Archive

Move an Object identified by {companyId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsCompaniesCompanyIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var companyId = "companyId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsCompaniesCompanyIdArchive(companyId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsCompaniesCompanyIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
companyId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteCrmV3ObjectsContactsContactIdArchive

void DeleteCrmV3ObjectsContactsContactIdArchive (string contactId)

Archive

Move an Object identified by {contactId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsContactsContactIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var contactId = "contactId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsContactsContactIdArchive(contactId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsContactsContactIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
contactId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteCrmV3ObjectsDealsDealIdArchive

void DeleteCrmV3ObjectsDealsDealIdArchive (string dealId)

Archive

Move an Object identified by {dealId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsDealsDealIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var dealId = "dealId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsDealsDealIdArchive(dealId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsDealsDealIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dealId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteCrmV3ObjectsLineItemsLineItemIdArchive

void DeleteCrmV3ObjectsLineItemsLineItemIdArchive (string lineItemId)

Archive

Move an Object identified by {lineItemId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsLineItemsLineItemIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var lineItemId = "lineItemId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsLineItemsLineItemIdArchive(lineItemId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsLineItemsLineItemIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
lineItemId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteCrmV3ObjectsObjectTypeObjectIdArchive

void DeleteCrmV3ObjectsObjectTypeObjectIdArchive (string objectType, string objectId)

Archive

Move an Object identified by {objectId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsObjectTypeObjectIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var objectType = "objectType_example";  // string | 
            var objectId = "objectId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsObjectTypeObjectIdArchive(objectType, objectId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsObjectTypeObjectIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
objectType	string
objectId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteCrmV3ObjectsProductsProductIdArchive

void DeleteCrmV3ObjectsProductsProductIdArchive (string productId)

Archive

Move an Object identified by {productId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsProductsProductIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var productId = "productId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsProductsProductIdArchive(productId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsProductsProductIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
productId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteCrmV3ObjectsTicketsTicketIdArchive

void DeleteCrmV3ObjectsTicketsTicketIdArchive (string ticketId)

Archive

Move an Object identified by {ticketId} to the recycling bin.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteCrmV3ObjectsTicketsTicketIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var ticketId = "ticketId_example";  // string | 

            try
            {
                // Archive
                apiInstance.DeleteCrmV3ObjectsTicketsTicketIdArchive(ticketId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteCrmV3ObjectsTicketsTicketIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ticketId	string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

DeleteMarketingV3MarketingEventsEventsExternalEventId

void DeleteMarketingV3MarketingEventsEventsExternalEventId (string externalEventId, string externalAccountId)

Delete a marketing event

Deletes an existing Marketing Event with the specified id, if one exists.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class DeleteMarketingV3MarketingEventsEventsExternalEventIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var externalEventId = "externalEventId_example";  // string | The id of the marketing event to delete
            var externalAccountId = "externalAccountId_example";  // string | The account id associated with the marketing event

            try
            {
                // Delete a marketing event
                apiInstance.DeleteMarketingV3MarketingEventsEventsExternalEventId(externalEventId, externalAccountId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.DeleteMarketingV3MarketingEventsEventsExternalEventId: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
externalEventId	string	The id of the marketing event to delete
externalAccountId	string	The account id associated with the marketing event

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
204	No content	-
0	An error occurred.	-

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

GetCrmV3ObjectsCompaniesCompanyIdGetById

CompaniesSimplePublicObjectWithAssociations GetCrmV3ObjectsCompaniesCompanyIdGetById (string companyId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsCompaniesCompanyIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var companyId = "companyId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                CompaniesSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsCompaniesCompanyIdGetById(companyId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsCompaniesCompanyIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
companyId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

CompaniesSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsCompaniesGetPage

CompaniesCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsCompaniesGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of companies. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsCompaniesGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                CompaniesCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsCompaniesGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsCompaniesGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

CompaniesCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsContactsContactIdGetById

ContactsSimplePublicObjectWithAssociations GetCrmV3ObjectsContactsContactIdGetById (string contactId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

Read

Read an Object identified by {contactId}. {contactId} refers to the internal object ID. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsContactsContactIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var contactId = "contactId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // Read
                ContactsSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsContactsContactIdGetById(contactId, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsContactsContactIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
contactId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

ContactsSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsContactsGetPage

ContactsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsContactsGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of contacts. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsContactsGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                ContactsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsContactsGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsContactsGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

ContactsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsDealsDealIdGetById

DealsSimplePublicObjectWithAssociations GetCrmV3ObjectsDealsDealIdGetById (string dealId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {dealId}. {dealId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsDealsDealIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var dealId = "dealId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                DealsSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsDealsDealIdGetById(dealId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsDealsDealIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dealId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

DealsSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsDealsGetPage

DealsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsDealsGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of deals. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsDealsGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                DealsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsDealsGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsDealsGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

DealsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsFeedbackSubmissionsFeedbackSubmissionIdGetById

FeedbackSubmissionsSimplePublicObjectWithAssociations GetCrmV3ObjectsFeedbackSubmissionsFeedbackSubmissionIdGetById (string feedbackSubmissionId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {feedbackSubmissionId}. {feedbackSubmissionId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsFeedbackSubmissionsFeedbackSubmissionIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var feedbackSubmissionId = "feedbackSubmissionId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                FeedbackSubmissionsSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsFeedbackSubmissionsFeedbackSubmissionIdGetById(feedbackSubmissionId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsFeedbackSubmissionsFeedbackSubmissionIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
feedbackSubmissionId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

FeedbackSubmissionsSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsFeedbackSubmissionsGetPage

FeedbackSubmissionsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsFeedbackSubmissionsGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of feedback submissions. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsFeedbackSubmissionsGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                FeedbackSubmissionsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsFeedbackSubmissionsGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsFeedbackSubmissionsGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

FeedbackSubmissionsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsLineItemsGetPage

LineItemsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsLineItemsGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of line items. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsLineItemsGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                LineItemsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsLineItemsGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsLineItemsGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

LineItemsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsLineItemsLineItemIdGetById

LineItemsSimplePublicObjectWithAssociations GetCrmV3ObjectsLineItemsLineItemIdGetById (string lineItemId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsLineItemsLineItemIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var lineItemId = "lineItemId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                LineItemsSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsLineItemsLineItemIdGetById(lineItemId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsLineItemsLineItemIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
lineItemId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

LineItemsSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsObjectTypeGetPage

ObjectsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsObjectTypeGetPage (string objectType, int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of objects. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsObjectTypeGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var objectType = "objectType_example";  // string | 
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                ObjectsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsObjectTypeGetPage(objectType, limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsObjectTypeGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
objectType	string
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

ObjectsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsObjectTypeObjectIdGetById

ObjectsSimplePublicObjectWithAssociations GetCrmV3ObjectsObjectTypeObjectIdGetById (string objectType, string objectId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {objectId}. {objectId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsObjectTypeObjectIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var objectType = "objectType_example";  // string | 
            var objectId = "objectId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                ObjectsSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsObjectTypeObjectIdGetById(objectType, objectId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsObjectTypeObjectIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
objectType	string
objectId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

ObjectsSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsProductsGetPage

CollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsProductsGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of products. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsProductsGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                CollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsProductsGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsProductsGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

CollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsProductsProductIdGetById

SimplePublicObjectWithAssociations GetCrmV3ObjectsProductsProductIdGetById (string productId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {productId}. {productId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsProductsProductIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var productId = "productId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                SimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsProductsProductIdGetById(productId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsProductsProductIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
productId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

SimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsQuotesGetPage

QuotesCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsQuotesGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of quotes. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsQuotesGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                QuotesCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsQuotesGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsQuotesGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

QuotesCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsQuotesQuoteIdGetById

QuotesSimplePublicObjectWithAssociations GetCrmV3ObjectsQuotesQuoteIdGetById (string quoteId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {quoteId}. {quoteId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsQuotesQuoteIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var quoteId = "quoteId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                QuotesSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsQuotesQuoteIdGetById(quoteId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsQuotesQuoteIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
quoteId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

QuotesSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsTicketsGetPage

TicketsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging GetCrmV3ObjectsTicketsGetPage (int? limit = null, string after = null, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null)

List

Read a page of tickets. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsTicketsGetPageExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var limit = 10;  // int? | The maximum number of results to display per page. (optional)  (default to 10)
            var after = "after_example";  // string | The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. (optional) 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)

            try
            {
                // List
                TicketsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging result = apiInstance.GetCrmV3ObjectsTicketsGetPage(limit, after, properties, propertiesWithHistory, associations, archived);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsTicketsGetPage: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
limit	int?	The maximum number of results to display per page.	[optional] [default to 10]
after	string	The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.	[optional]
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]

Return type

TicketsCollectionResponseSimplePublicObjectWithAssociationsForwardPaging

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetCrmV3ObjectsTicketsTicketIdGetById

TicketsSimplePublicObjectWithAssociations GetCrmV3ObjectsTicketsTicketIdGetById (string ticketId, List properties = null, List propertiesWithHistory = null, List associations = null, bool? archived = null, string idProperty = null)

Read

Read an Object identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetCrmV3ObjectsTicketsTicketIdGetByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var ticketId = "ticketId_example";  // string | 
            var properties = new List<string>(); // List<string> | A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var propertiesWithHistory = new List<string>(); // List<string> | A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. (optional) 
            var associations = new List<string>(); // List<string> | A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. (optional) 
            var archived = false;  // bool? | Whether to return only results that have been archived. (optional)  (default to false)
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Read
                TicketsSimplePublicObjectWithAssociations result = apiInstance.GetCrmV3ObjectsTicketsTicketIdGetById(ticketId, properties, propertiesWithHistory, associations, archived, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetCrmV3ObjectsTicketsTicketIdGetById: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ticketId	string
properties	List<string>	A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
propertiesWithHistory	List<string>	A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.	[optional]
associations	List<string>	A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.	[optional]
archived	bool?	Whether to return only results that have been archived.	[optional] [default to false]
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

TicketsSimplePublicObjectWithAssociations

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

GetMarketingV3MarketingEventsEventsExternalEventId

MarketingEventPublicReadResponse GetMarketingV3MarketingEventsEventsExternalEventId (string externalEventId, string externalAccountId)

Get a marketing event

Returns the details of the Marketing Event with the specified id, if one exists.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class GetMarketingV3MarketingEventsEventsExternalEventIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var externalEventId = "externalEventId_example";  // string | The id of the marketing event to return
            var externalAccountId = "externalAccountId_example";  // string | The account id associated with the marketing event

            try
            {
                // Get a marketing event
                MarketingEventPublicReadResponse result = apiInstance.GetMarketingV3MarketingEventsEventsExternalEventId(externalEventId, externalAccountId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.GetMarketingV3MarketingEventsEventsExternalEventId: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
externalEventId	string	The id of the marketing event to return
externalAccountId	string	The account id associated with the marketing event

Return type

MarketingEventPublicReadResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsCompaniesCompanyIdUpdate

CompaniesSimplePublicObject PatchCrmV3ObjectsCompaniesCompanyIdUpdate (string companyId, CompaniesSimplePublicObjectInput companiesSimplePublicObjectInput, string idProperty = null)

Update

Perform a partial update of an Object identified by {companyId}. {companyId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsCompaniesCompanyIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var companyId = "companyId_example";  // string | 
            var companiesSimplePublicObjectInput = new CompaniesSimplePublicObjectInput(); // CompaniesSimplePublicObjectInput | 
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Update
                CompaniesSimplePublicObject result = apiInstance.PatchCrmV3ObjectsCompaniesCompanyIdUpdate(companyId, companiesSimplePublicObjectInput, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsCompaniesCompanyIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
companyId	string
companiesSimplePublicObjectInput	CompaniesSimplePublicObjectInput
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

CompaniesSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsContactsContactIdUpdate

ContactsSimplePublicObject PatchCrmV3ObjectsContactsContactIdUpdate (string contactId, ContactsSimplePublicObjectInput contactsSimplePublicObjectInput)

Update

Perform a partial update of an Object identified by {contactId}. {contactId} refers to the internal object ID. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsContactsContactIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var contactId = "contactId_example";  // string | 
            var contactsSimplePublicObjectInput = new ContactsSimplePublicObjectInput(); // ContactsSimplePublicObjectInput | 

            try
            {
                // Update
                ContactsSimplePublicObject result = apiInstance.PatchCrmV3ObjectsContactsContactIdUpdate(contactId, contactsSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsContactsContactIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
contactId	string
contactsSimplePublicObjectInput	ContactsSimplePublicObjectInput

Return type

ContactsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsDealsDealIdUpdate

DealsSimplePublicObject PatchCrmV3ObjectsDealsDealIdUpdate (string dealId, DealsSimplePublicObjectInput dealsSimplePublicObjectInput, string idProperty = null)

Update

Perform a partial update of an Object identified by {dealId}. {dealId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsDealsDealIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var dealId = "dealId_example";  // string | 
            var dealsSimplePublicObjectInput = new DealsSimplePublicObjectInput(); // DealsSimplePublicObjectInput | 
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Update
                DealsSimplePublicObject result = apiInstance.PatchCrmV3ObjectsDealsDealIdUpdate(dealId, dealsSimplePublicObjectInput, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsDealsDealIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dealId	string
dealsSimplePublicObjectInput	DealsSimplePublicObjectInput
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

DealsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsLineItemsLineItemIdUpdate

LineItemsSimplePublicObject PatchCrmV3ObjectsLineItemsLineItemIdUpdate (string lineItemId, LineItemsSimplePublicObjectInput lineItemsSimplePublicObjectInput, string idProperty = null)

Update

Perform a partial update of an Object identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsLineItemsLineItemIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var lineItemId = "lineItemId_example";  // string | 
            var lineItemsSimplePublicObjectInput = new LineItemsSimplePublicObjectInput(); // LineItemsSimplePublicObjectInput | 
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Update
                LineItemsSimplePublicObject result = apiInstance.PatchCrmV3ObjectsLineItemsLineItemIdUpdate(lineItemId, lineItemsSimplePublicObjectInput, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsLineItemsLineItemIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
lineItemId	string
lineItemsSimplePublicObjectInput	LineItemsSimplePublicObjectInput
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

LineItemsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsObjectTypeObjectIdUpdate

ObjectsSimplePublicObject PatchCrmV3ObjectsObjectTypeObjectIdUpdate (string objectType, string objectId, ObjectsSimplePublicObjectInput objectsSimplePublicObjectInput, string idProperty = null)

Update

Perform a partial update of an Object identified by {objectId}. {objectId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsObjectTypeObjectIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var objectType = "objectType_example";  // string | 
            var objectId = "objectId_example";  // string | 
            var objectsSimplePublicObjectInput = new ObjectsSimplePublicObjectInput(); // ObjectsSimplePublicObjectInput | 
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Update
                ObjectsSimplePublicObject result = apiInstance.PatchCrmV3ObjectsObjectTypeObjectIdUpdate(objectType, objectId, objectsSimplePublicObjectInput, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsObjectTypeObjectIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
objectType	string
objectId	string
objectsSimplePublicObjectInput	ObjectsSimplePublicObjectInput
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

ObjectsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsProductsProductIdUpdate

SimplePublicObject PatchCrmV3ObjectsProductsProductIdUpdate (string productId, SimplePublicObjectInput simplePublicObjectInput, string idProperty = null)

Update

Perform a partial update of an Object identified by {productId}. {productId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsProductsProductIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var productId = "productId_example";  // string | 
            var simplePublicObjectInput = new SimplePublicObjectInput(); // SimplePublicObjectInput | 
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Update
                SimplePublicObject result = apiInstance.PatchCrmV3ObjectsProductsProductIdUpdate(productId, simplePublicObjectInput, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsProductsProductIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
productId	string
simplePublicObjectInput	SimplePublicObjectInput
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

SimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchCrmV3ObjectsTicketsTicketIdUpdate

TicketsSimplePublicObject PatchCrmV3ObjectsTicketsTicketIdUpdate (string ticketId, TicketsSimplePublicObjectInput ticketsSimplePublicObjectInput, string idProperty = null)

Update

Perform a partial update of an Object identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchCrmV3ObjectsTicketsTicketIdUpdateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var ticketId = "ticketId_example";  // string | 
            var ticketsSimplePublicObjectInput = new TicketsSimplePublicObjectInput(); // TicketsSimplePublicObjectInput | 
            var idProperty = "idProperty_example";  // string | The name of a property whose values are unique for this object type (optional) 

            try
            {
                // Update
                TicketsSimplePublicObject result = apiInstance.PatchCrmV3ObjectsTicketsTicketIdUpdate(ticketId, ticketsSimplePublicObjectInput, idProperty);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchCrmV3ObjectsTicketsTicketIdUpdate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ticketId	string
ticketsSimplePublicObjectInput	TicketsSimplePublicObjectInput
idProperty	string	The name of a property whose values are unique for this object type	[optional]

Return type

TicketsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PatchMarketingV3MarketingEventsEventsExternalEventId

MarketingEventPublicDefaultResponse PatchMarketingV3MarketingEventsEventsExternalEventId (string externalEventId, string externalAccountId, MarketingEventUpdateRequestParams marketingEventUpdateRequestParams)

Update a marketing event

Updates an existing Marketing Event with the specified id, if one exists.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PatchMarketingV3MarketingEventsEventsExternalEventIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var externalEventId = "externalEventId_example";  // string | The id of the marketing event to update
            var externalAccountId = "externalAccountId_example";  // string | The account id associated with the marketing event
            var marketingEventUpdateRequestParams = new MarketingEventUpdateRequestParams(); // MarketingEventUpdateRequestParams | The details of the marketing event to update

            try
            {
                // Update a marketing event
                MarketingEventPublicDefaultResponse result = apiInstance.PatchMarketingV3MarketingEventsEventsExternalEventId(externalEventId, externalAccountId, marketingEventUpdateRequestParams);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PatchMarketingV3MarketingEventsEventsExternalEventId: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description
externalEventId	string	The id of the marketing event to update
externalAccountId	string	The account id associated with the marketing event
marketingEventUpdateRequestParams	MarketingEventUpdateRequestParams	The details of the marketing event to update

Return type

MarketingEventPublicDefaultResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsCompaniesCreate

CompaniesSimplePublicObject PostCrmV3ObjectsCompaniesCreate (CompaniesSimplePublicObjectInput companiesSimplePublicObjectInput)

Create

Create a company with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard companies is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsCompaniesCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var companiesSimplePublicObjectInput = new CompaniesSimplePublicObjectInput(); // CompaniesSimplePublicObjectInput | 

            try
            {
                // Create
                CompaniesSimplePublicObject result = apiInstance.PostCrmV3ObjectsCompaniesCreate(companiesSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsCompaniesCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
companiesSimplePublicObjectInput	CompaniesSimplePublicObjectInput

Return type

CompaniesSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsContactsCreate

ContactsSimplePublicObject PostCrmV3ObjectsContactsCreate (ContactsSimplePublicObjectInput contactsSimplePublicObjectInput)

Create

Create a contact with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard contacts is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsContactsCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var contactsSimplePublicObjectInput = new ContactsSimplePublicObjectInput(); // ContactsSimplePublicObjectInput | 

            try
            {
                // Create
                ContactsSimplePublicObject result = apiInstance.PostCrmV3ObjectsContactsCreate(contactsSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsContactsCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
contactsSimplePublicObjectInput	ContactsSimplePublicObjectInput

Return type

ContactsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsDealsCreate

DealsSimplePublicObject PostCrmV3ObjectsDealsCreate (DealsSimplePublicObjectInput dealsSimplePublicObjectInput)

Create

Create a deal with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard deals is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsDealsCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var dealsSimplePublicObjectInput = new DealsSimplePublicObjectInput(); // DealsSimplePublicObjectInput | 

            try
            {
                // Create
                DealsSimplePublicObject result = apiInstance.PostCrmV3ObjectsDealsCreate(dealsSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsDealsCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
dealsSimplePublicObjectInput	DealsSimplePublicObjectInput

Return type

DealsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsLineItemsCreate

LineItemsSimplePublicObject PostCrmV3ObjectsLineItemsCreate (LineItemsSimplePublicObjectInput lineItemsSimplePublicObjectInput)

Create

Create a line item with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard line items is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsLineItemsCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var lineItemsSimplePublicObjectInput = new LineItemsSimplePublicObjectInput(); // LineItemsSimplePublicObjectInput | 

            try
            {
                // Create
                LineItemsSimplePublicObject result = apiInstance.PostCrmV3ObjectsLineItemsCreate(lineItemsSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsLineItemsCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
lineItemsSimplePublicObjectInput	LineItemsSimplePublicObjectInput

Return type

LineItemsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsObjectTypeCreate

ObjectsSimplePublicObject PostCrmV3ObjectsObjectTypeCreate (string objectType, ObjectsSimplePublicObjectInput objectsSimplePublicObjectInput)

Create

Create a CRM object with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard objects is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsObjectTypeCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var objectType = "objectType_example";  // string | 
            var objectsSimplePublicObjectInput = new ObjectsSimplePublicObjectInput(); // ObjectsSimplePublicObjectInput | 

            try
            {
                // Create
                ObjectsSimplePublicObject result = apiInstance.PostCrmV3ObjectsObjectTypeCreate(objectType, objectsSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsObjectTypeCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
objectType	string
objectsSimplePublicObjectInput	ObjectsSimplePublicObjectInput

Return type

ObjectsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsProductsCreate

SimplePublicObject PostCrmV3ObjectsProductsCreate (SimplePublicObjectInput simplePublicObjectInput)

Create

Create a product with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard products is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsProductsCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var simplePublicObjectInput = new SimplePublicObjectInput(); // SimplePublicObjectInput | 

            try
            {
                // Create
                SimplePublicObject result = apiInstance.PostCrmV3ObjectsProductsCreate(simplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsProductsCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
simplePublicObjectInput	SimplePublicObjectInput

Return type

SimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostCrmV3ObjectsTicketsCreate

TicketsSimplePublicObject PostCrmV3ObjectsTicketsCreate (TicketsSimplePublicObjectInput ticketsSimplePublicObjectInput)

Create

Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostCrmV3ObjectsTicketsCreateExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var ticketsSimplePublicObjectInput = new TicketsSimplePublicObjectInput(); // TicketsSimplePublicObjectInput | 

            try
            {
                // Create
                TicketsSimplePublicObject result = apiInstance.PostCrmV3ObjectsTicketsCreate(ticketsSimplePublicObjectInput);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostCrmV3ObjectsTicketsCreate: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
ticketsSimplePublicObjectInput	TicketsSimplePublicObjectInput

Return type

TicketsSimplePublicObject

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	successful operation	-
0	An error occurred.	-

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

PostMarketingV3MarketingEventsEvents

MarketingEventDefaultResponse PostMarketingV3MarketingEventsEvents (MarketingEventCreateRequestParams marketingEventCreateRequestParams)

Create a marketing event

Creates a new marketing event in HubSpot

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostMarketingV3MarketingEventsEventsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var marketingEventCreateRequestParams = new MarketingEventCreateRequestParams(); // MarketingEventCreateRequestParams | The details of the marketing event to create

            try
            {
                // Create a marketing event
                MarketingEventDefaultResponse result = apiInstance.PostMarketingV3MarketingEventsEvents(marketingEventCreateRequestParams);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostMarketingV3MarketingEventsEvents: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
marketingEventCreateRequestParams	MarketingEventCreateRequestParams	The details of the marketing event to create

Return type

MarketingEventDefaultResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PostMarketingV3MarketingEventsEventsExternalEventIdCancel

MarketingEventDefaultResponse PostMarketingV3MarketingEventsEventsExternalEventIdCancel (string externalEventId, string externalAccountId)

Mark a marketing event as cancelled

Mark a marketing event as cancelled.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PostMarketingV3MarketingEventsEventsExternalEventIdCancelExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var externalEventId = "externalEventId_example";  // string | The id of the marketing event to mark as cancelled
            var externalAccountId = "externalAccountId_example";  // string | The account id associated with the marketing event

            try
            {
                // Mark a marketing event as cancelled
                MarketingEventDefaultResponse result = apiInstance.PostMarketingV3MarketingEventsEventsExternalEventIdCancel(externalEventId, externalAccountId);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PostMarketingV3MarketingEventsEventsExternalEventIdCancel: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
externalEventId	string	The id of the marketing event to mark as cancelled
externalAccountId	string	The account id associated with the marketing event

Return type

MarketingEventDefaultResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json, /

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

PutMarketingV3MarketingEventsEventsExternalEventId

MarketingEventPublicDefaultResponse PutMarketingV3MarketingEventsEventsExternalEventId (string externalEventId, MarketingEventCreateRequestParams marketingEventCreateRequestParams)

Create or update a marketing event

Upsets a Marketing Event. If there is an existing Marketing event with the specified id, it will be updated; otherwise a new event will be created.

Example

using System.Collections.Generic;
using System.Diagnostics;
using HubSpot.NET.Api;
using HubSpot.NET.Client;
using HubSpot.NET.Model;

namespace Example
{
    public class PutMarketingV3MarketingEventsEventsExternalEventIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new BasicApi(config);
            var externalEventId = "externalEventId_example";  // string | The id of the marketing event to upsert
            var marketingEventCreateRequestParams = new MarketingEventCreateRequestParams(); // MarketingEventCreateRequestParams | The details of the marketing event to upsert

            try
            {
                // Create or update a marketing event
                MarketingEventPublicDefaultResponse result = apiInstance.PutMarketingV3MarketingEventsEventsExternalEventId(externalEventId, marketingEventCreateRequestParams);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling BasicApi.PutMarketingV3MarketingEventsEventsExternalEventId: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
externalEventId	string	The id of the marketing event to upsert
marketingEventCreateRequestParams	MarketingEventCreateRequestParams	The details of the marketing event to upsert

Return type

MarketingEventPublicDefaultResponse

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	successful operation	-
0	An error occurred.	-

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

Files

BasicApi.md

Latest commit

History

BasicApi.md

File metadata and controls

HubSpot.NET.Api.BasicApi

DeleteCrmV3ObjectsCompaniesCompanyIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteCrmV3ObjectsContactsContactIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteCrmV3ObjectsDealsDealIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteCrmV3ObjectsLineItemsLineItemIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteCrmV3ObjectsObjectTypeObjectIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteCrmV3ObjectsProductsProductIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteCrmV3ObjectsTicketsTicketIdArchive

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

DeleteMarketingV3MarketingEventsEventsExternalEventId

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetCrmV3ObjectsCompaniesCompanyIdGetById

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetCrmV3ObjectsCompaniesGetPage

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetCrmV3ObjectsContactsContactIdGetById

Example

Parameters