Skip to content

UserAccountsApi.md

Latest commit

 

History

History
152 lines (114 loc) · 5.26 KB

UserAccountsApi.md

File metadata and controls

152 lines (114 loc) · 5.26 KB

HubSpot.NET.Api.UserAccountsApi

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

Method HTTP request Description
DeleteCrmV3ExtensionsAccountingUserAccountsAccountIdArchive DELETE /crm/v3/extensions/accounting/user-accounts/{accountId} Delete user account
PutCrmV3ExtensionsAccountingUserAccountsReplace PUT /crm/v3/extensions/accounting/user-accounts Create a user account

DeleteCrmV3ExtensionsAccountingUserAccountsAccountIdArchive

void DeleteCrmV3ExtensionsAccountingUserAccountsAccountIdArchive (string accountId)

Delete user account

Deletes a user account from HubSpot, meaning that HubSpot will no longer send requests to the external accounting system for this user.

Example

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

namespace Example
{
    public class DeleteCrmV3ExtensionsAccountingUserAccountsAccountIdArchiveExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new UserAccountsApi(config);
            var accountId = "accountId_example";  // string | The ID of the user account to delete.

            try
            {
                // Delete user account
                apiInstance.DeleteCrmV3ExtensionsAccountingUserAccountsAccountIdArchive(accountId);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserAccountsApi.DeleteCrmV3ExtensionsAccountingUserAccountsAccountIdArchive: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
accountId string The ID of the user account to delete.

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]

PutCrmV3ExtensionsAccountingUserAccountsReplace

void PutCrmV3ExtensionsAccountingUserAccountsReplace (CreateUserAccountRequestExternal createUserAccountRequestExternal)

Create a user account

Creates an account which contains the information about the account in the external accounting system. This must be called after a user connects their HubSpot account to the external accounting system, as there is no other way for HubSpot to obtain the external account details.

Example

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

namespace Example
{
    public class PutCrmV3ExtensionsAccountingUserAccountsReplaceExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.hubapi.com";
            var apiInstance = new UserAccountsApi(config);
            var createUserAccountRequestExternal = new CreateUserAccountRequestExternal(); // CreateUserAccountRequestExternal | The external accounting system user account information.

            try
            {
                // Create a user account
                apiInstance.PutCrmV3ExtensionsAccountingUserAccountsReplace(createUserAccountRequestExternal);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling UserAccountsApi.PutCrmV3ExtensionsAccountingUserAccountsReplace: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name Type Description Notes
createUserAccountRequestExternal CreateUserAccountRequestExternal The external accounting system user account information.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • 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]