Ooctopus™

AccountAgentBots

createAnAccountAgentBot

Create an Agent Bot

Create an agent bot in the account


/api/v1/accounts/{account_id}/agent_bots

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agent_bots"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAgentBotsApi;

import java.io.File;
import java.util.*;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.createAnAccountAgentBot(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#createAnAccountAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAgentBotsApi;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.createAnAccountAgentBot(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#createAnAccountAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Agent_bot_create_update_payload *data = ; // 

AccountAgentBotsApi *apiInstance = [[AccountAgentBotsApi alloc] init];

// Create an Agent Bot
[apiInstance createAnAccountAgentBotWith:accountId
    data:data
              completionHandler: ^(agent_bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountAgentBotsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Agent_bot_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAnAccountAgentBot(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAnAccountAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountAgentBotsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Agent_bot_create_update_payload(); // Agent_bot_create_update_payload | 

            try
            {
                // Create an Agent Bot
                agent_bot result = apiInstance.createAnAccountAgentBot(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAgentBotsApi.createAnAccountAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountAgentBotsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Agent_bot_create_update_payload | 

try {
    $result = $api_instance->createAnAccountAgentBot($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAgentBotsApi->createAnAccountAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAgentBotsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountAgentBotsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Agent_bot_create_update_payload->new(); # Agent_bot_create_update_payload | 

eval { 
    my $result = $api_instance->createAnAccountAgentBot(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAgentBotsApi->createAnAccountAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountAgentBotsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Agent_bot_create_update_payload | 

try: 
    # Create an Agent Bot
    api_response = api_instance.create_an_account_agent_bot(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAgentBotsApi->createAnAccountAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


deleteAnAccountAgentBot

Delete an AgentBot

Delete an AgentBot from the account


/api/v1/accounts/{account_id}/agent_bots/{id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agent_bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAgentBotsApi;

import java.io.File;
import java.util.*;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            apiInstance.deleteAnAccountAgentBot(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#deleteAnAccountAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAgentBotsApi;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            apiInstance.deleteAnAccountAgentBot(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#deleteAnAccountAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the agentbot to be updated

AccountAgentBotsApi *apiInstance = [[AccountAgentBotsApi alloc] init];

// Delete an AgentBot
[apiInstance deleteAnAccountAgentBotWith:accountId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountAgentBotsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the agentbot to be updated


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAnAccountAgentBot(accountId, id, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAnAccountAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountAgentBotsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the agentbot to be updated

            try
            {
                // Delete an AgentBot
                apiInstance.deleteAnAccountAgentBot(accountId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAgentBotsApi.deleteAnAccountAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountAgentBotsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the agentbot to be updated

try {
    $api_instance->deleteAnAccountAgentBot($accountId, $id);
} catch (Exception $e) {
    echo 'Exception when calling AccountAgentBotsApi->deleteAnAccountAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAgentBotsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountAgentBotsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the agentbot to be updated

eval { 
    $api_instance->deleteAnAccountAgentBot(accountId => $accountId, id => $id);
};
if ($@) {
    warn "Exception when calling AccountAgentBotsApi->deleteAnAccountAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountAgentBotsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the agentbot to be updated

try: 
    # Delete an AgentBot
    api_instance.delete_an_account_agent_bot(accountId, id)
except ApiException as e:
    print("Exception when calling AccountAgentBotsApi->deleteAnAccountAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the agentbot to be updated
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The agent bot does not exist in the account


getDetailsOfASingleAccountAgentBot

Get an agent bot details

Get the details of an agent bot in the account


/api/v1/accounts/{account_id}/agent_bots/{id}

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agent_bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAgentBotsApi;

import java.io.File;
import java.util.*;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            agent_bot result = apiInstance.getDetailsOfASingleAccountAgentBot(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#getDetailsOfASingleAccountAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAgentBotsApi;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            agent_bot result = apiInstance.getDetailsOfASingleAccountAgentBot(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#getDetailsOfASingleAccountAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the agentbot to be updated

AccountAgentBotsApi *apiInstance = [[AccountAgentBotsApi alloc] init];

// Get an agent bot details
[apiInstance getDetailsOfASingleAccountAgentBotWith:accountId
    id:id
              completionHandler: ^(agent_bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountAgentBotsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the agentbot to be updated


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDetailsOfASingleAccountAgentBot(accountId, id, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDetailsOfASingleAccountAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountAgentBotsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the agentbot to be updated

            try
            {
                // Get an agent bot details
                agent_bot result = apiInstance.getDetailsOfASingleAccountAgentBot(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAgentBotsApi.getDetailsOfASingleAccountAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountAgentBotsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the agentbot to be updated

try {
    $result = $api_instance->getDetailsOfASingleAccountAgentBot($accountId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAgentBotsApi->getDetailsOfASingleAccountAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAgentBotsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountAgentBotsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the agentbot to be updated

eval { 
    my $result = $api_instance->getDetailsOfASingleAccountAgentBot(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAgentBotsApi->getDetailsOfASingleAccountAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountAgentBotsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the agentbot to be updated

try: 
    # Get an agent bot details
    api_response = api_instance.get_details_of_a_single_account_agent_bot(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAgentBotsApi->getDetailsOfASingleAccountAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the agentbot to be updated
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given agent bot ID does not exist in the account


listAllAccountAgentBots

List all AgentBots

List all agent bots available for the current account


/api/v1/accounts/{account_id}/agent_bots

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agent_bots"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAgentBotsApi;

import java.io.File;
import java.util.*;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[agent_bot] result = apiInstance.listAllAccountAgentBots(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#listAllAccountAgentBots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAgentBotsApi;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[agent_bot] result = apiInstance.listAllAccountAgentBots(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#listAllAccountAgentBots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account

AccountAgentBotsApi *apiInstance = [[AccountAgentBotsApi alloc] init];

// List all AgentBots
[apiInstance listAllAccountAgentBotsWith:accountId
              completionHandler: ^(array[agent_bot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountAgentBotsApi()

var accountId = 56; // {Integer} The numeric ID of the account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllAccountAgentBots(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllAccountAgentBotsExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountAgentBotsApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all AgentBots
                array[agent_bot] result = apiInstance.listAllAccountAgentBots(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAgentBotsApi.listAllAccountAgentBots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountAgentBotsApi();
$accountId = 56; // Integer | The numeric ID of the account

try {
    $result = $api_instance->listAllAccountAgentBots($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAgentBotsApi->listAllAccountAgentBots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAgentBotsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountAgentBotsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->listAllAccountAgentBots(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAgentBotsApi->listAllAccountAgentBots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountAgentBotsApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all AgentBots
    api_response = api_instance.list_all_account_agent_bots(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAgentBotsApi->listAllAccountAgentBots: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized


updateAnAccountAgentBot

Update an agent bot

Update an agent bot's attributes


/api/v1/accounts/{account_id}/agent_bots/{id}

Usage and SDK Samples

curl -X PATCH -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agent_bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountAgentBotsApi;

import java.io.File;
import java.util.*;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.updateAnAccountAgentBot(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#updateAnAccountAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountAgentBotsApi;

public class AccountAgentBotsApiExample {

    public static void main(String[] args) {
        AccountAgentBotsApi apiInstance = new AccountAgentBotsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.updateAnAccountAgentBot(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountAgentBotsApi#updateAnAccountAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the agentbot to be updated
Agent_bot_create_update_payload *data = ; // 

AccountAgentBotsApi *apiInstance = [[AccountAgentBotsApi alloc] init];

// Update an agent bot
[apiInstance updateAnAccountAgentBotWith:accountId
    id:id
    data:data
              completionHandler: ^(agent_bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountAgentBotsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the agentbot to be updated

var data = ; // {Agent_bot_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAnAccountAgentBot(accountId, id, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAnAccountAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountAgentBotsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the agentbot to be updated
            var data = new Agent_bot_create_update_payload(); // Agent_bot_create_update_payload | 

            try
            {
                // Update an agent bot
                agent_bot result = apiInstance.updateAnAccountAgentBot(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountAgentBotsApi.updateAnAccountAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountAgentBotsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the agentbot to be updated
$data = ; // Agent_bot_create_update_payload | 

try {
    $result = $api_instance->updateAnAccountAgentBot($accountId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountAgentBotsApi->updateAnAccountAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountAgentBotsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountAgentBotsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the agentbot to be updated
my $data = WWW::SwaggerClient::Object::Agent_bot_create_update_payload->new(); # Agent_bot_create_update_payload | 

eval { 
    my $result = $api_instance->updateAnAccountAgentBot(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountAgentBotsApi->updateAnAccountAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountAgentBotsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the agentbot to be updated
data =  # Agent_bot_create_update_payload | 

try: 
    # Update an agent bot
    api_response = api_instance.update_an_account_agent_bot(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountAgentBotsApi->updateAnAccountAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the agentbot to be updated
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


AccountUsers

createAnAccountUser

Create an Account User

Create an Account User


/platform/api/v1/accounts/{account_id}/account_users

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts/{account_id}/account_users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountUsersApi;

import java.io.File;
import java.util.*;

public class AccountUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountUsersApi apiInstance = new AccountUsersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data data = ; // Data | 
        try {
            Object result = apiInstance.createAnAccountUser(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountUsersApi#createAnAccountUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountUsersApi;

public class AccountUsersApiExample {

    public static void main(String[] args) {
        AccountUsersApi apiInstance = new AccountUsersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data data = ; // Data | 
        try {
            Object result = apiInstance.createAnAccountUser(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountUsersApi#createAnAccountUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Data *data = ; // 

AccountUsersApi *apiInstance = [[AccountUsersApi alloc] init];

// Create an Account User
[apiInstance createAnAccountUserWith:accountId
    data:data
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountUsersApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Data} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAnAccountUser(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAnAccountUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountUsersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data(); // Data | 

            try
            {
                // Create an Account User
                Object result = apiInstance.createAnAccountUser(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountUsersApi.createAnAccountUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountUsersApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data | 

try {
    $result = $api_instance->createAnAccountUser($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountUsersApi->createAnAccountUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountUsersApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountUsersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data->new(); # Data | 

eval { 
    my $result = $api_instance->createAnAccountUser(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountUsersApi->createAnAccountUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountUsersApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data | 

try: 
    # Create an Account User
    api_response = api_instance.create_an_account_user(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountUsersApi->createAnAccountUser: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


deleteAnAccountUser

Delete an Account User

Delete an Account User


/platform/api/v1/accounts/{account_id}/account_users

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts/{account_id}/account_users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountUsersApi;

import java.io.File;
import java.util.*;

public class AccountUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountUsersApi apiInstance = new AccountUsersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_1 data = ; // Data_1 | 
        try {
            apiInstance.deleteAnAccountUser(accountId, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountUsersApi#deleteAnAccountUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountUsersApi;

public class AccountUsersApiExample {

    public static void main(String[] args) {
        AccountUsersApi apiInstance = new AccountUsersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_1 data = ; // Data_1 | 
        try {
            apiInstance.deleteAnAccountUser(accountId, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountUsersApi#deleteAnAccountUser");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Data_1 *data = ; // 

AccountUsersApi *apiInstance = [[AccountUsersApi alloc] init];

// Delete an Account User
[apiInstance deleteAnAccountUserWith:accountId
    data:data
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountUsersApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Data_1} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAnAccountUser(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAnAccountUserExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountUsersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data_1(); // Data_1 | 

            try
            {
                // Delete an Account User
                apiInstance.deleteAnAccountUser(accountId, data);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountUsersApi.deleteAnAccountUser: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountUsersApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data_1 | 

try {
    $api_instance->deleteAnAccountUser($accountId, $data);
} catch (Exception $e) {
    echo 'Exception when calling AccountUsersApi->deleteAnAccountUser: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountUsersApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountUsersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data_1->new(); # Data_1 | 

eval { 
    $api_instance->deleteAnAccountUser(accountId => $accountId, data => $data);
};
if ($@) {
    warn "Exception when calling AccountUsersApi->deleteAnAccountUser: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountUsersApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data_1 | 

try: 
    # Delete an Account User
    api_instance.delete_an_account_user(accountId, data)
except ApiException as e:
    print("Exception when calling AccountUsersApi->deleteAnAccountUser: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The account does not exist


listAllAccountUsers

List all Account Users

List all account users


/platform/api/v1/accounts/{account_id}/account_users

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts/{account_id}/account_users"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountUsersApi;

import java.io.File;
import java.util.*;

public class AccountUsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountUsersApi apiInstance = new AccountUsersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[inline_response_200] result = apiInstance.listAllAccountUsers(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountUsersApi#listAllAccountUsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountUsersApi;

public class AccountUsersApiExample {

    public static void main(String[] args) {
        AccountUsersApi apiInstance = new AccountUsersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[inline_response_200] result = apiInstance.listAllAccountUsers(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountUsersApi#listAllAccountUsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account

AccountUsersApi *apiInstance = [[AccountUsersApi alloc] init];

// List all Account Users
[apiInstance listAllAccountUsersWith:accountId
              completionHandler: ^(array[inline_response_200] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountUsersApi()

var accountId = 56; // {Integer} The numeric ID of the account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllAccountUsers(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllAccountUsersExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountUsersApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all Account Users
                array[inline_response_200] result = apiInstance.listAllAccountUsers(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountUsersApi.listAllAccountUsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountUsersApi();
$accountId = 56; // Integer | The numeric ID of the account

try {
    $result = $api_instance->listAllAccountUsers($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountUsersApi->listAllAccountUsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountUsersApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountUsersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->listAllAccountUsers(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountUsersApi->listAllAccountUsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountUsersApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all Account Users
    api_response = api_instance.list_all_account_users(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountUsersApi->listAllAccountUsers: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Accounts

createAnAccount

Create an Account

Create an Account


/platform/api/v1/accounts

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountsApi apiInstance = new AccountsApi();
        Account_create_update_payload data = ; // Account_create_update_payload | 
        try {
            platform_account result = apiInstance.createAnAccount(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#createAnAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Account_create_update_payload data = ; // Account_create_update_payload | 
        try {
            platform_account result = apiInstance.createAnAccount(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#createAnAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Account_create_update_payload *data = ; // 

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Create an Account
[apiInstance createAnAccountWith:data
              completionHandler: ^(platform_account output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountsApi()

var data = ; // {Account_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAnAccount(data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAnAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountsApi();
            var data = new Account_create_update_payload(); // Account_create_update_payload | 

            try
            {
                // Create an Account
                platform_account result = apiInstance.createAnAccount(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.createAnAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountsApi();
$data = ; // Account_create_update_payload | 

try {
    $result = $api_instance->createAnAccount($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->createAnAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $data = WWW::SwaggerClient::Object::Account_create_update_payload->new(); # Account_create_update_payload | 

eval { 
    my $result = $api_instance->createAnAccount(data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->createAnAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
data =  # Account_create_update_payload | 

try: 
    # Create an Account
    api_response = api_instance.create_an_account(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->createAnAccount: %s\n" % e)

Parameters

Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


deleteAnAccount

Delete an Account

Delete an Account


/platform/api/v1/accounts/{account_id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts/{account_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountsApi apiInstance = new AccountsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            apiInstance.deleteAnAccount(accountId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#deleteAnAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            apiInstance.deleteAnAccount(accountId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#deleteAnAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Delete an Account
[apiInstance deleteAnAccountWith:accountId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountsApi()

var accountId = 56; // {Integer} The numeric ID of the account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAnAccount(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAnAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountsApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // Delete an Account
                apiInstance.deleteAnAccount(accountId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.deleteAnAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountsApi();
$accountId = 56; // Integer | The numeric ID of the account

try {
    $api_instance->deleteAnAccount($accountId);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->deleteAnAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    $api_instance->deleteAnAccount(accountId => $accountId);
};
if ($@) {
    warn "Exception when calling AccountsApi->deleteAnAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # Delete an Account
    api_instance.delete_an_account(accountId)
except ApiException as e:
    print("Exception when calling AccountsApi->deleteAnAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The account does not exist


getDetailsOfAnAccount

Get an account details

Get the details of an account


/platform/api/v1/accounts/{account_id}

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts/{account_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountsApi apiInstance = new AccountsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            platform_account result = apiInstance.getDetailsOfAnAccount(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getDetailsOfAnAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            platform_account result = apiInstance.getDetailsOfAnAccount(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#getDetailsOfAnAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Get an account details
[apiInstance getDetailsOfAnAccountWith:accountId
              completionHandler: ^(platform_account output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountsApi()

var accountId = 56; // {Integer} The numeric ID of the account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDetailsOfAnAccount(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDetailsOfAnAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountsApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // Get an account details
                platform_account result = apiInstance.getDetailsOfAnAccount(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.getDetailsOfAnAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountsApi();
$accountId = 56; // Integer | The numeric ID of the account

try {
    $result = $api_instance->getDetailsOfAnAccount($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getDetailsOfAnAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->getDetailsOfAnAccount(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->getDetailsOfAnAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # Get an account details
    api_response = api_instance.get_details_of_an_account(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->getDetailsOfAnAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given account does not exist


updateAnAccount

Update an account

Update an account's attributes


/platform/api/v1/accounts/{account_id}

Usage and SDK Samples

curl -X PATCH -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/accounts/{account_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccountsApi;

import java.io.File;
import java.util.*;

public class AccountsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AccountsApi apiInstance = new AccountsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Account_create_update_payload data = ; // Account_create_update_payload | 
        try {
            platform_account result = apiInstance.updateAnAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#updateAnAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccountsApi;

public class AccountsApiExample {

    public static void main(String[] args) {
        AccountsApi apiInstance = new AccountsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Account_create_update_payload data = ; // Account_create_update_payload | 
        try {
            platform_account result = apiInstance.updateAnAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountsApi#updateAnAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Account_create_update_payload *data = ; // 

AccountsApi *apiInstance = [[AccountsApi alloc] init];

// Update an account
[apiInstance updateAnAccountWith:accountId
    data:data
              completionHandler: ^(platform_account output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AccountsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Account_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAnAccount(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAnAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AccountsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Account_create_update_payload(); // Account_create_update_payload | 

            try
            {
                // Update an account
                platform_account result = apiInstance.updateAnAccount(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccountsApi.updateAnAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AccountsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Account_create_update_payload | 

try {
    $result = $api_instance->updateAnAccount($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->updateAnAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccountsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccountsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Account_create_update_payload->new(); # Account_create_update_payload | 

eval { 
    my $result = $api_instance->updateAnAccount(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccountsApi->updateAnAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AccountsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Account_create_update_payload | 

try: 
    # Update an account
    api_response = api_instance.update_an_account(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->updateAnAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


AgentBots

createAnAgentBot

Create an Agent Bot

Create an agent bot


/platform/api/v1/agent_bots

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/agent_bots"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentBotsApi;

import java.io.File;
import java.util.*;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AgentBotsApi apiInstance = new AgentBotsApi();
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.createAnAgentBot(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#createAnAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentBotsApi;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        AgentBotsApi apiInstance = new AgentBotsApi();
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.createAnAgentBot(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#createAnAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Agent_bot_create_update_payload *data = ; // 

AgentBotsApi *apiInstance = [[AgentBotsApi alloc] init];

// Create an Agent Bot
[apiInstance createAnAgentBotWith:data
              completionHandler: ^(agent_bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentBotsApi()

var data = ; // {Agent_bot_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAnAgentBot(data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAnAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentBotsApi();
            var data = new Agent_bot_create_update_payload(); // Agent_bot_create_update_payload | 

            try
            {
                // Create an Agent Bot
                agent_bot result = apiInstance.createAnAgentBot(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentBotsApi.createAnAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentBotsApi();
$data = ; // Agent_bot_create_update_payload | 

try {
    $result = $api_instance->createAnAgentBot($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentBotsApi->createAnAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentBotsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentBotsApi->new();
my $data = WWW::SwaggerClient::Object::Agent_bot_create_update_payload->new(); # Agent_bot_create_update_payload | 

eval { 
    my $result = $api_instance->createAnAgentBot(data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentBotsApi->createAnAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentBotsApi()
data =  # Agent_bot_create_update_payload | 

try: 
    # Create an Agent Bot
    api_response = api_instance.create_an_agent_bot(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentBotsApi->createAnAgentBot: %s\n" % e)

Parameters

Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


deleteAnAgentBot

Delete an AgentBot

Delete an AgentBot


/platform/api/v1/agent_bots/{id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/agent_bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentBotsApi;

import java.io.File;
import java.util.*;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AgentBotsApi apiInstance = new AgentBotsApi();
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            apiInstance.deleteAnAgentBot(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#deleteAnAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentBotsApi;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        AgentBotsApi apiInstance = new AgentBotsApi();
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            apiInstance.deleteAnAgentBot(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#deleteAnAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *id = 56; // The ID of the agentbot to be updated

AgentBotsApi *apiInstance = [[AgentBotsApi alloc] init];

// Delete an AgentBot
[apiInstance deleteAnAgentBotWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentBotsApi()

var id = 56; // {Integer} The ID of the agentbot to be updated


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAnAgentBot(id, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAnAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentBotsApi();
            var id = 56;  // Integer | The ID of the agentbot to be updated

            try
            {
                // Delete an AgentBot
                apiInstance.deleteAnAgentBot(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentBotsApi.deleteAnAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentBotsApi();
$id = 56; // Integer | The ID of the agentbot to be updated

try {
    $api_instance->deleteAnAgentBot($id);
} catch (Exception $e) {
    echo 'Exception when calling AgentBotsApi->deleteAnAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentBotsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentBotsApi->new();
my $id = 56; # Integer | The ID of the agentbot to be updated

eval { 
    $api_instance->deleteAnAgentBot(id => $id);
};
if ($@) {
    warn "Exception when calling AgentBotsApi->deleteAnAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentBotsApi()
id = 56 # Integer | The ID of the agentbot to be updated

try: 
    # Delete an AgentBot
    api_instance.delete_an_agent_bot(id)
except ApiException as e:
    print("Exception when calling AgentBotsApi->deleteAnAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The ID of the agentbot to be updated
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The agent bot does not exist


getDetailsOfASingleAgentBot

Get an agent bot details

Get the details of an agent bot


/platform/api/v1/agent_bots/{id}

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/agent_bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentBotsApi;

import java.io.File;
import java.util.*;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AgentBotsApi apiInstance = new AgentBotsApi();
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            agent_bot result = apiInstance.getDetailsOfASingleAgentBot(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#getDetailsOfASingleAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentBotsApi;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        AgentBotsApi apiInstance = new AgentBotsApi();
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        try {
            agent_bot result = apiInstance.getDetailsOfASingleAgentBot(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#getDetailsOfASingleAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *id = 56; // The ID of the agentbot to be updated

AgentBotsApi *apiInstance = [[AgentBotsApi alloc] init];

// Get an agent bot details
[apiInstance getDetailsOfASingleAgentBotWith:id
              completionHandler: ^(agent_bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentBotsApi()

var id = 56; // {Integer} The ID of the agentbot to be updated


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDetailsOfASingleAgentBot(id, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDetailsOfASingleAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentBotsApi();
            var id = 56;  // Integer | The ID of the agentbot to be updated

            try
            {
                // Get an agent bot details
                agent_bot result = apiInstance.getDetailsOfASingleAgentBot(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentBotsApi.getDetailsOfASingleAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentBotsApi();
$id = 56; // Integer | The ID of the agentbot to be updated

try {
    $result = $api_instance->getDetailsOfASingleAgentBot($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentBotsApi->getDetailsOfASingleAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentBotsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentBotsApi->new();
my $id = 56; # Integer | The ID of the agentbot to be updated

eval { 
    my $result = $api_instance->getDetailsOfASingleAgentBot(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentBotsApi->getDetailsOfASingleAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentBotsApi()
id = 56 # Integer | The ID of the agentbot to be updated

try: 
    # Get an agent bot details
    api_response = api_instance.get_details_of_a_single_agent_bot(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentBotsApi->getDetailsOfASingleAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The ID of the agentbot to be updated
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given agent bot ID does not exist


listAllAgentBots

List all AgentBots

List all agent bots available


/platform/api/v1/agent_bots

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/agent_bots"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentBotsApi;

import java.io.File;
import java.util.*;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AgentBotsApi apiInstance = new AgentBotsApi();
        try {
            array[agent_bot] result = apiInstance.listAllAgentBots();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#listAllAgentBots");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentBotsApi;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        AgentBotsApi apiInstance = new AgentBotsApi();
        try {
            array[agent_bot] result = apiInstance.listAllAgentBots();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#listAllAgentBots");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];


AgentBotsApi *apiInstance = [[AgentBotsApi alloc] init];

// List all AgentBots
[apiInstance listAllAgentBotsWithCompletionHandler: 
              ^(array[agent_bot] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentBotsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAllAgentBots(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllAgentBotsExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentBotsApi();

            try
            {
                // List all AgentBots
                array[agent_bot] result = apiInstance.listAllAgentBots();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentBotsApi.listAllAgentBots: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentBotsApi();

try {
    $result = $api_instance->listAllAgentBots();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentBotsApi->listAllAgentBots: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentBotsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentBotsApi->new();

eval { 
    my $result = $api_instance->listAllAgentBots();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentBotsApi->listAllAgentBots: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentBotsApi()

try: 
    # List all AgentBots
    api_response = api_instance.list_all_agent_bots()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentBotsApi->listAllAgentBots: %s\n" % e)

Parameters

Responses

Status: 200 - Success

Status: 401 - Unauthorized


updateAnAgentBot

Update an agent bot

Update an agent bot's attributes


/platform/api/v1/agent_bots/{id}

Usage and SDK Samples

curl -X PATCH -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/platform/api/v1/agent_bots/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentBotsApi;

import java.io.File;
import java.util.*;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: platformAppApiKey
        ApiKeyAuth platformAppApiKey = (ApiKeyAuth) defaultClient.getAuthentication("platformAppApiKey");
        platformAppApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //platformAppApiKey.setApiKeyPrefix("Token");

        AgentBotsApi apiInstance = new AgentBotsApi();
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.updateAnAgentBot(id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#updateAnAgentBot");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentBotsApi;

public class AgentBotsApiExample {

    public static void main(String[] args) {
        AgentBotsApi apiInstance = new AgentBotsApi();
        Integer id = 56; // Integer | The ID of the agentbot to be updated
        Agent_bot_create_update_payload data = ; // Agent_bot_create_update_payload | 
        try {
            agent_bot result = apiInstance.updateAnAgentBot(id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentBotsApi#updateAnAgentBot");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: platformAppApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *id = 56; // The ID of the agentbot to be updated
Agent_bot_create_update_payload *data = ; // 

AgentBotsApi *apiInstance = [[AgentBotsApi alloc] init];

// Update an agent bot
[apiInstance updateAnAgentBotWith:id
    data:data
              completionHandler: ^(agent_bot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: platformAppApiKey
var platformAppApiKey = defaultClient.authentications['platformAppApiKey'];
platformAppApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//platformAppApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentBotsApi()

var id = 56; // {Integer} The ID of the agentbot to be updated

var data = ; // {Agent_bot_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAnAgentBot(id, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAnAgentBotExample
    {
        public void main()
        {
            
            // Configure API key authorization: platformAppApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentBotsApi();
            var id = 56;  // Integer | The ID of the agentbot to be updated
            var data = new Agent_bot_create_update_payload(); // Agent_bot_create_update_payload | 

            try
            {
                // Update an agent bot
                agent_bot result = apiInstance.updateAnAgentBot(id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentBotsApi.updateAnAgentBot: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: platformAppApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentBotsApi();
$id = 56; // Integer | The ID of the agentbot to be updated
$data = ; // Agent_bot_create_update_payload | 

try {
    $result = $api_instance->updateAnAgentBot($id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentBotsApi->updateAnAgentBot: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentBotsApi;

# Configure API key authorization: platformAppApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentBotsApi->new();
my $id = 56; # Integer | The ID of the agentbot to be updated
my $data = WWW::SwaggerClient::Object::Agent_bot_create_update_payload->new(); # Agent_bot_create_update_payload | 

eval { 
    my $result = $api_instance->updateAnAgentBot(id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentBotsApi->updateAnAgentBot: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: platformAppApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentBotsApi()
id = 56 # Integer | The ID of the agentbot to be updated
data =  # Agent_bot_create_update_payload | 

try: 
    # Update an agent bot
    api_response = api_instance.update_an_agent_bot(id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentBotsApi->updateAnAgentBot: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The ID of the agentbot to be updated
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Agents

addNewAgentToAccount

Add a New Agent

Add a new Agent to Account


/api/v1/accounts/{account_id}/agents

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;

import java.io.File;
import java.util.*;

public class AgentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_2 data = ; // Data_2 | 
        try {
            agent result = apiInstance.addNewAgentToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#addNewAgentToAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentsApi;

public class AgentsApiExample {

    public static void main(String[] args) {
        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_2 data = ; // Data_2 | 
        try {
            agent result = apiInstance.addNewAgentToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#addNewAgentToAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Data_2 *data = ; // 

AgentsApi *apiInstance = [[AgentsApi alloc] init];

// Add a New Agent
[apiInstance addNewAgentToAccountWith:accountId
    data:data
              completionHandler: ^(agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Data_2} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addNewAgentToAccount(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addNewAgentToAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data_2(); // Data_2 | 

            try
            {
                // Add a New Agent
                agent result = apiInstance.addNewAgentToAccount(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentsApi.addNewAgentToAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data_2 | 

try {
    $result = $api_instance->addNewAgentToAccount($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentsApi->addNewAgentToAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data_2->new(); # Data_2 | 

eval { 
    my $result = $api_instance->addNewAgentToAccount(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentsApi->addNewAgentToAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data_2 | 

try: 
    # Add a New Agent
    api_response = api_instance.add_new_agent_to_account(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentsApi->addNewAgentToAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 403 - Access denied


deleteAgentFromAccount

Remove an Agent from Account

Remove an Agent from Account


/api/v1/accounts/{account_id}/agents/{id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agents/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;

import java.io.File;
import java.util.*;

public class AgentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agent to be deleted
        try {
            apiInstance.deleteAgentFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#deleteAgentFromAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentsApi;

public class AgentsApiExample {

    public static void main(String[] args) {
        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agent to be deleted
        try {
            apiInstance.deleteAgentFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#deleteAgentFromAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the agent to be deleted

AgentsApi *apiInstance = [[AgentsApi alloc] init];

// Remove an Agent from Account
[apiInstance deleteAgentFromAccountWith:accountId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the agent to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAgentFromAccount(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAgentFromAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the agent to be deleted

            try
            {
                // Remove an Agent from Account
                apiInstance.deleteAgentFromAccount(accountId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentsApi.deleteAgentFromAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the agent to be deleted

try {
    $api_instance->deleteAgentFromAccount($accountId, $id);
} catch (Exception $e) {
    echo 'Exception when calling AgentsApi->deleteAgentFromAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the agent to be deleted

eval { 
    $api_instance->deleteAgentFromAccount(accountId => $accountId, id => $id);
};
if ($@) {
    warn "Exception when calling AgentsApi->deleteAgentFromAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the agent to be deleted

try: 
    # Remove an Agent from Account
    api_instance.delete_agent_from_account(accountId, id)
except ApiException as e:
    print("Exception when calling AgentsApi->deleteAgentFromAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the agent to be deleted
Required

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Agent not found


getAccountAgents

List Agents in Account

Get Details of Agents in an Account


/api/v1/accounts/{account_id}/agents

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agents"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;

import java.io.File;
import java.util.*;

public class AgentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[agent] result = apiInstance.getAccountAgents(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#getAccountAgents");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentsApi;

public class AgentsApiExample {

    public static void main(String[] args) {
        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[agent] result = apiInstance.getAccountAgents(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#getAccountAgents");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account

AgentsApi *apiInstance = [[AgentsApi alloc] init];

// List Agents in Account
[apiInstance getAccountAgentsWith:accountId
              completionHandler: ^(array[agent] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentsApi()

var accountId = 56; // {Integer} The numeric ID of the account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountAgents(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountAgentsExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentsApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List Agents in Account
                array[agent] result = apiInstance.getAccountAgents(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentsApi.getAccountAgents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentsApi();
$accountId = 56; // Integer | The numeric ID of the account

try {
    $result = $api_instance->getAccountAgents($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentsApi->getAccountAgents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->getAccountAgents(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentsApi->getAccountAgents: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentsApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List Agents in Account
    api_response = api_instance.get_account_agents(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentsApi->getAccountAgents: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required

Responses

Status: 200 - Success

Status: 403 - Access denied


updateAgentInAccount

Update Agent in Account

Update an Agent in Account


/api/v1/accounts/{account_id}/agents/{id}

Usage and SDK Samples

curl -X PATCH -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/agents/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AgentsApi;

import java.io.File;
import java.util.*;

public class AgentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agent to be updated.
        Data_3 data = ; // Data_3 | 
        try {
            agent result = apiInstance.updateAgentInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#updateAgentInAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AgentsApi;

public class AgentsApiExample {

    public static void main(String[] args) {
        AgentsApi apiInstance = new AgentsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the agent to be updated.
        Data_3 data = ; // Data_3 | 
        try {
            agent result = apiInstance.updateAgentInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AgentsApi#updateAgentInAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the agent to be updated.
Data_3 *data = ; // 

AgentsApi *apiInstance = [[AgentsApi alloc] init];

// Update Agent in Account
[apiInstance updateAgentInAccountWith:accountId
    id:id
    data:data
              completionHandler: ^(agent output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AgentsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the agent to be updated.

var data = ; // {Data_3} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAgentInAccount(accountId, id, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAgentInAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AgentsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the agent to be updated.
            var data = new Data_3(); // Data_3 | 

            try
            {
                // Update Agent in Account
                agent result = apiInstance.updateAgentInAccount(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AgentsApi.updateAgentInAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AgentsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the agent to be updated.
$data = ; // Data_3 | 

try {
    $result = $api_instance->updateAgentInAccount($accountId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AgentsApi->updateAgentInAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AgentsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AgentsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the agent to be updated.
my $data = WWW::SwaggerClient::Object::Data_3->new(); # Data_3 | 

eval { 
    my $result = $api_instance->updateAgentInAccount(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AgentsApi->updateAgentInAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AgentsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the agent to be updated.
data =  # Data_3 | 

try: 
    # Update Agent in Account
    api_response = api_instance.update_agent_in_account(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AgentsApi->updateAgentInAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the agent to be updated.
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Agent not found


AutomationRule

addNewAutomationRuleToAccount

Add a new automation rule

Add a new automation rule to account


/api/v1/accounts/{account_id}/automation_rules

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/automation_rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationRuleApi;

import java.io.File;
import java.util.*;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Automation_rule_create_update_payload data = ; // Automation_rule_create_update_payload | 
        try {
            automation_rule result = apiInstance.addNewAutomationRuleToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#addNewAutomationRuleToAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutomationRuleApi;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Automation_rule_create_update_payload data = ; // Automation_rule_create_update_payload | 
        try {
            automation_rule result = apiInstance.addNewAutomationRuleToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#addNewAutomationRuleToAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Automation_rule_create_update_payload *data = ; // 

AutomationRuleApi *apiInstance = [[AutomationRuleApi alloc] init];

// Add a new automation rule
[apiInstance addNewAutomationRuleToAccountWith:accountId
    data:data
              completionHandler: ^(automation_rule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AutomationRuleApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Automation_rule_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addNewAutomationRuleToAccount(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addNewAutomationRuleToAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AutomationRuleApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Automation_rule_create_update_payload(); // Automation_rule_create_update_payload | 

            try
            {
                // Add a new automation rule
                automation_rule result = apiInstance.addNewAutomationRuleToAccount(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationRuleApi.addNewAutomationRuleToAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AutomationRuleApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Automation_rule_create_update_payload | 

try {
    $result = $api_instance->addNewAutomationRuleToAccount($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationRuleApi->addNewAutomationRuleToAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationRuleApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AutomationRuleApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Automation_rule_create_update_payload->new(); # Automation_rule_create_update_payload | 

eval { 
    my $result = $api_instance->addNewAutomationRuleToAccount(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationRuleApi->addNewAutomationRuleToAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AutomationRuleApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Automation_rule_create_update_payload | 

try: 
    # Add a new automation rule
    api_response = api_instance.add_new_automation_rule_to_account(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationRuleApi->addNewAutomationRuleToAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 403 - Access denied


deleteAutomationRuleFromAccount

Remove a automation rule from account

Remove a automation rule from account


/api/v1/accounts/{account_id}/automation_rules/{id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/automation_rules/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationRuleApi;

import java.io.File;
import java.util.*;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the automation rule to be deleted
        try {
            apiInstance.deleteAutomationRuleFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#deleteAutomationRuleFromAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutomationRuleApi;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the automation rule to be deleted
        try {
            apiInstance.deleteAutomationRuleFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#deleteAutomationRuleFromAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the automation rule to be deleted

AutomationRuleApi *apiInstance = [[AutomationRuleApi alloc] init];

// Remove a automation rule from account
[apiInstance deleteAutomationRuleFromAccountWith:accountId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AutomationRuleApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the automation rule to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteAutomationRuleFromAccount(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAutomationRuleFromAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AutomationRuleApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the automation rule to be deleted

            try
            {
                // Remove a automation rule from account
                apiInstance.deleteAutomationRuleFromAccount(accountId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationRuleApi.deleteAutomationRuleFromAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AutomationRuleApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the automation rule to be deleted

try {
    $api_instance->deleteAutomationRuleFromAccount($accountId, $id);
} catch (Exception $e) {
    echo 'Exception when calling AutomationRuleApi->deleteAutomationRuleFromAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationRuleApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AutomationRuleApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the automation rule to be deleted

eval { 
    $api_instance->deleteAutomationRuleFromAccount(accountId => $accountId, id => $id);
};
if ($@) {
    warn "Exception when calling AutomationRuleApi->deleteAutomationRuleFromAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AutomationRuleApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the automation rule to be deleted

try: 
    # Remove a automation rule from account
    api_instance.delete_automation_rule_from_account(accountId, id)
except ApiException as e:
    print("Exception when calling AutomationRuleApi->deleteAutomationRuleFromAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the automation rule to be deleted
Required

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - automation rule not found


getAccountAutomationRule

List all automation rules in an account

Get details of automation rules in an Account


/api/v1/accounts/{account_id}/automation_rules

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/automation_rules?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationRuleApi;

import java.io.File;
import java.util.*;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer page = 56; // Integer | The page parameter
        try {
            array[automation_rule] result = apiInstance.getAccountAutomationRule(accountId, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#getAccountAutomationRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutomationRuleApi;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer page = 56; // Integer | The page parameter
        try {
            array[automation_rule] result = apiInstance.getAccountAutomationRule(accountId, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#getAccountAutomationRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *page = 56; // The page parameter (optional) (default to 1)

AutomationRuleApi *apiInstance = [[AutomationRuleApi alloc] init];

// List all automation rules in an account
[apiInstance getAccountAutomationRuleWith:accountId
    page:page
              completionHandler: ^(array[automation_rule] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AutomationRuleApi()

var accountId = 56; // {Integer} The numeric ID of the account

var opts = { 
  'page': 56 // {Integer} The page parameter
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountAutomationRule(accountId, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountAutomationRuleExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AutomationRuleApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var page = 56;  // Integer | The page parameter (optional)  (default to 1)

            try
            {
                // List all automation rules in an account
                array[automation_rule] result = apiInstance.getAccountAutomationRule(accountId, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationRuleApi.getAccountAutomationRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AutomationRuleApi();
$accountId = 56; // Integer | The numeric ID of the account
$page = 56; // Integer | The page parameter

try {
    $result = $api_instance->getAccountAutomationRule($accountId, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationRuleApi->getAccountAutomationRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationRuleApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AutomationRuleApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $page = 56; # Integer | The page parameter

eval { 
    my $result = $api_instance->getAccountAutomationRule(accountId => $accountId, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationRuleApi->getAccountAutomationRule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AutomationRuleApi()
accountId = 56 # Integer | The numeric ID of the account
page = 56 # Integer | The page parameter (optional) (default to 1)

try: 
    # List all automation rules in an account
    api_response = api_instance.get_account_automation_rule(accountId, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationRuleApi->getAccountAutomationRule: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
page
Integer
The page parameter

Responses

Status: 200 - Success

Status: 403 - Access denied


getDetailsOfASingleAutomationRule

Get a automation rule details

Get the details of a automation rule in the account


/api/v1/accounts/{account_id}/automation_rules/{id}

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/automation_rules/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationRuleApi;

import java.io.File;
import java.util.*;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the automation rule to be updated.
        try {
            automation_rule result = apiInstance.getDetailsOfASingleAutomationRule(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#getDetailsOfASingleAutomationRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutomationRuleApi;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the automation rule to be updated.
        try {
            automation_rule result = apiInstance.getDetailsOfASingleAutomationRule(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#getDetailsOfASingleAutomationRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the automation rule to be updated.

AutomationRuleApi *apiInstance = [[AutomationRuleApi alloc] init];

// Get a automation rule details
[apiInstance getDetailsOfASingleAutomationRuleWith:accountId
    id:id
              completionHandler: ^(automation_rule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AutomationRuleApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the automation rule to be updated.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDetailsOfASingleAutomationRule(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDetailsOfASingleAutomationRuleExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AutomationRuleApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the automation rule to be updated.

            try
            {
                // Get a automation rule details
                automation_rule result = apiInstance.getDetailsOfASingleAutomationRule(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationRuleApi.getDetailsOfASingleAutomationRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AutomationRuleApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the automation rule to be updated.

try {
    $result = $api_instance->getDetailsOfASingleAutomationRule($accountId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationRuleApi->getDetailsOfASingleAutomationRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationRuleApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AutomationRuleApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the automation rule to be updated.

eval { 
    my $result = $api_instance->getDetailsOfASingleAutomationRule(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationRuleApi->getDetailsOfASingleAutomationRule: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AutomationRuleApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the automation rule to be updated.

try: 
    # Get a automation rule details
    api_response = api_instance.get_details_of_a_single_automation_rule(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationRuleApi->getDetailsOfASingleAutomationRule: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the automation rule to be updated.
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given rule ID does not exist in the account


updateAutomationRuleInAccount

Update automation rule in Account

Update a automation rule in account


/api/v1/accounts/{account_id}/automation_rules/{id}

Usage and SDK Samples

curl -X PATCH -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/automation_rules/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AutomationRuleApi;

import java.io.File;
import java.util.*;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the automation rule to be updated.
        Automation_rule_create_update_payload data = ; // Automation_rule_create_update_payload | 
        try {
            automation_rule result = apiInstance.updateAutomationRuleInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#updateAutomationRuleInAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AutomationRuleApi;

public class AutomationRuleApiExample {

    public static void main(String[] args) {
        AutomationRuleApi apiInstance = new AutomationRuleApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the automation rule to be updated.
        Automation_rule_create_update_payload data = ; // Automation_rule_create_update_payload | 
        try {
            automation_rule result = apiInstance.updateAutomationRuleInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AutomationRuleApi#updateAutomationRuleInAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the automation rule to be updated.
Automation_rule_create_update_payload *data = ; // 

AutomationRuleApi *apiInstance = [[AutomationRuleApi alloc] init];

// Update automation rule in Account
[apiInstance updateAutomationRuleInAccountWith:accountId
    id:id
    data:data
              completionHandler: ^(automation_rule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.AutomationRuleApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the automation rule to be updated.

var data = ; // {Automation_rule_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAutomationRuleInAccount(accountId, id, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAutomationRuleInAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new AutomationRuleApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the automation rule to be updated.
            var data = new Automation_rule_create_update_payload(); // Automation_rule_create_update_payload | 

            try
            {
                // Update automation rule in Account
                automation_rule result = apiInstance.updateAutomationRuleInAccount(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationRuleApi.updateAutomationRuleInAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\AutomationRuleApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the automation rule to be updated.
$data = ; // Automation_rule_create_update_payload | 

try {
    $result = $api_instance->updateAutomationRuleInAccount($accountId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AutomationRuleApi->updateAutomationRuleInAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AutomationRuleApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AutomationRuleApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the automation rule to be updated.
my $data = WWW::SwaggerClient::Object::Automation_rule_create_update_payload->new(); # Automation_rule_create_update_payload | 

eval { 
    my $result = $api_instance->updateAutomationRuleInAccount(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AutomationRuleApi->updateAutomationRuleInAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AutomationRuleApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the automation rule to be updated.
data =  # Automation_rule_create_update_payload | 

try: 
    # Update automation rule in Account
    api_response = api_instance.update_automation_rule_in_account(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AutomationRuleApi->updateAutomationRuleInAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the automation rule to be updated.
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Rule not found


CannedResponse

updateCannedResponseInAccount

Update Canned Response in Account

Update a Canned Response in Account


/api/v1/accounts/{account_id}/canned_responses/{id}

Usage and SDK Samples

curl -X PATCH -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/canned_responses/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CannedResponseApi;

import java.io.File;
import java.util.*;

public class CannedResponseApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        CannedResponseApi apiInstance = new CannedResponseApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the canned response to be updated.
        Canned_response_create_update_payload data = ; // Canned_response_create_update_payload | 
        try {
            canned_response result = apiInstance.updateCannedResponseInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponseApi#updateCannedResponseInAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CannedResponseApi;

public class CannedResponseApiExample {

    public static void main(String[] args) {
        CannedResponseApi apiInstance = new CannedResponseApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the canned response to be updated.
        Canned_response_create_update_payload data = ; // Canned_response_create_update_payload | 
        try {
            canned_response result = apiInstance.updateCannedResponseInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponseApi#updateCannedResponseInAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the canned response to be updated.
Canned_response_create_update_payload *data = ; // 

CannedResponseApi *apiInstance = [[CannedResponseApi alloc] init];

// Update Canned Response in Account
[apiInstance updateCannedResponseInAccountWith:accountId
    id:id
    data:data
              completionHandler: ^(canned_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.CannedResponseApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the canned response to be updated.

var data = ; // {Canned_response_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCannedResponseInAccount(accountId, id, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateCannedResponseInAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new CannedResponseApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the canned response to be updated.
            var data = new Canned_response_create_update_payload(); // Canned_response_create_update_payload | 

            try
            {
                // Update Canned Response in Account
                canned_response result = apiInstance.updateCannedResponseInAccount(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CannedResponseApi.updateCannedResponseInAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\CannedResponseApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the canned response to be updated.
$data = ; // Canned_response_create_update_payload | 

try {
    $result = $api_instance->updateCannedResponseInAccount($accountId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CannedResponseApi->updateCannedResponseInAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CannedResponseApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CannedResponseApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the canned response to be updated.
my $data = WWW::SwaggerClient::Object::Canned_response_create_update_payload->new(); # Canned_response_create_update_payload | 

eval { 
    my $result = $api_instance->updateCannedResponseInAccount(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CannedResponseApi->updateCannedResponseInAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CannedResponseApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the canned response to be updated.
data =  # Canned_response_create_update_payload | 

try: 
    # Update Canned Response in Account
    api_response = api_instance.update_canned_response_in_account(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CannedResponseApi->updateCannedResponseInAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the canned response to be updated.
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Agent not found


CannedResponses

addNewCannedResponseToAccount

Add a New Canned Response

Add a new Canned Response to Account


/api/v1/accounts/{account_id}/canned_responses

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/canned_responses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CannedResponsesApi;

import java.io.File;
import java.util.*;

public class CannedResponsesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        CannedResponsesApi apiInstance = new CannedResponsesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Canned_response_create_update_payload data = ; // Canned_response_create_update_payload | 
        try {
            canned_response result = apiInstance.addNewCannedResponseToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponsesApi#addNewCannedResponseToAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CannedResponsesApi;

public class CannedResponsesApiExample {

    public static void main(String[] args) {
        CannedResponsesApi apiInstance = new CannedResponsesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Canned_response_create_update_payload data = ; // Canned_response_create_update_payload | 
        try {
            canned_response result = apiInstance.addNewCannedResponseToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponsesApi#addNewCannedResponseToAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Canned_response_create_update_payload *data = ; // 

CannedResponsesApi *apiInstance = [[CannedResponsesApi alloc] init];

// Add a New Canned Response
[apiInstance addNewCannedResponseToAccountWith:accountId
    data:data
              completionHandler: ^(canned_response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.CannedResponsesApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Canned_response_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addNewCannedResponseToAccount(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addNewCannedResponseToAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new CannedResponsesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Canned_response_create_update_payload(); // Canned_response_create_update_payload | 

            try
            {
                // Add a New Canned Response
                canned_response result = apiInstance.addNewCannedResponseToAccount(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CannedResponsesApi.addNewCannedResponseToAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\CannedResponsesApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Canned_response_create_update_payload | 

try {
    $result = $api_instance->addNewCannedResponseToAccount($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CannedResponsesApi->addNewCannedResponseToAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CannedResponsesApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CannedResponsesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Canned_response_create_update_payload->new(); # Canned_response_create_update_payload | 

eval { 
    my $result = $api_instance->addNewCannedResponseToAccount(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CannedResponsesApi->addNewCannedResponseToAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CannedResponsesApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Canned_response_create_update_payload | 

try: 
    # Add a New Canned Response
    api_response = api_instance.add_new_canned_response_to_account(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CannedResponsesApi->addNewCannedResponseToAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 403 - Access denied


deleteCannedResponseFromAccount

Remove a Canned Response from Account

Remove a Canned Response from Account


/api/v1/accounts/{account_id}/canned_responses/{id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/canned_responses/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CannedResponsesApi;

import java.io.File;
import java.util.*;

public class CannedResponsesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        CannedResponsesApi apiInstance = new CannedResponsesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the canned response to be deleted
        try {
            apiInstance.deleteCannedResponseFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponsesApi#deleteCannedResponseFromAccount");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CannedResponsesApi;

public class CannedResponsesApiExample {

    public static void main(String[] args) {
        CannedResponsesApi apiInstance = new CannedResponsesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the canned response to be deleted
        try {
            apiInstance.deleteCannedResponseFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponsesApi#deleteCannedResponseFromAccount");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Integer *id = 56; // The ID of the canned response to be deleted

CannedResponsesApi *apiInstance = [[CannedResponsesApi alloc] init];

// Remove a Canned Response from Account
[apiInstance deleteCannedResponseFromAccountWith:accountId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.CannedResponsesApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 56; // {Integer} The ID of the canned response to be deleted


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteCannedResponseFromAccount(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteCannedResponseFromAccountExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new CannedResponsesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the canned response to be deleted

            try
            {
                // Remove a Canned Response from Account
                apiInstance.deleteCannedResponseFromAccount(accountId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CannedResponsesApi.deleteCannedResponseFromAccount: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\CannedResponsesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the canned response to be deleted

try {
    $api_instance->deleteCannedResponseFromAccount($accountId, $id);
} catch (Exception $e) {
    echo 'Exception when calling CannedResponsesApi->deleteCannedResponseFromAccount: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CannedResponsesApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CannedResponsesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the canned response to be deleted

eval { 
    $api_instance->deleteCannedResponseFromAccount(accountId => $accountId, id => $id);
};
if ($@) {
    warn "Exception when calling CannedResponsesApi->deleteCannedResponseFromAccount: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CannedResponsesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the canned response to be deleted

try: 
    # Remove a Canned Response from Account
    api_instance.delete_canned_response_from_account(accountId, id)
except ApiException as e:
    print("Exception when calling CannedResponsesApi->deleteCannedResponseFromAccount: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
Integer
The ID of the canned response to be deleted
Required

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Canned Response not found


getAccountCannedResponse

List all Canned Responses in an Account

Get Details of Canned Responses in an Account


/api/v1/accounts/{account_id}/canned_responses

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/canned_responses"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CannedResponsesApi;

import java.io.File;
import java.util.*;

public class CannedResponsesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        CannedResponsesApi apiInstance = new CannedResponsesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[canned_response] result = apiInstance.getAccountCannedResponse(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponsesApi#getAccountCannedResponse");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CannedResponsesApi;

public class CannedResponsesApiExample {

    public static void main(String[] args) {
        CannedResponsesApi apiInstance = new CannedResponsesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[canned_response] result = apiInstance.getAccountCannedResponse(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CannedResponsesApi#getAccountCannedResponse");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account

CannedResponsesApi *apiInstance = [[CannedResponsesApi alloc] init];

// List all Canned Responses in an Account
[apiInstance getAccountCannedResponseWith:accountId
              completionHandler: ^(array[canned_response] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.CannedResponsesApi()

var accountId = 56; // {Integer} The numeric ID of the account


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccountCannedResponse(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAccountCannedResponseExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new CannedResponsesApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all Canned Responses in an Account
                array[canned_response] result = apiInstance.getAccountCannedResponse(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CannedResponsesApi.getAccountCannedResponse: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\CannedResponsesApi();
$accountId = 56; // Integer | The numeric ID of the account

try {
    $result = $api_instance->getAccountCannedResponse($accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CannedResponsesApi->getAccountCannedResponse: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CannedResponsesApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CannedResponsesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->getAccountCannedResponse(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CannedResponsesApi->getAccountCannedResponse: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CannedResponsesApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all Canned Responses in an Account
    api_response = api_instance.get_account_canned_response(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CannedResponsesApi->getAccountCannedResponse: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required

Responses

Status: 200 - Success

Status: 403 - Access denied


Contact

contactInboxCreation

Create contact inbox

Create a contact inbox record for an inbox


/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

import java.io.File;
import java.util.*;

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactApi apiInstance = new ContactApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        Data_4 data = ; // Data_4 | 
        try {
            contact_inboxes result = apiInstance.contactInboxCreation(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#contactInboxCreation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        Data_4 data = ; // Data_4 | 
        try {
            contact_inboxes result = apiInstance.contactInboxCreation(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#contactInboxCreation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
BigDecimal *id = 8.14; // ID of the contact
Data_4 *data = ; // 

ContactApi *apiInstance = [[ContactApi alloc] init];

// Create contact inbox
[apiInstance contactInboxCreationWith:accountId
    id:id
    data:data
              completionHandler: ^(contact_inboxes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 8.14; // {BigDecimal} ID of the contact

var data = ; // {Data_4} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactInboxCreation(accountId, id, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactInboxCreationExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the contact
            var data = new Data_4(); // Data_4 | 

            try
            {
                // Create contact inbox
                contact_inboxes result = apiInstance.contactInboxCreation(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.contactInboxCreation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the contact
$data = ; // Data_4 | 

try {
    $result = $api_instance->contactInboxCreation($accountId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->contactInboxCreation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the contact
my $data = WWW::SwaggerClient::Object::Data_4->new(); # Data_4 | 

eval { 
    my $result = $api_instance->contactInboxCreation(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->contactInboxCreation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the contact
data =  # Data_4 | 

try: 
    # Create contact inbox
    api_response = api_instance.contact_inbox_creation(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->contactInboxCreation: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
BigDecimal
ID of the contact
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Authentication error

Status: 422 - Incorrect payload


contactableInboxesGet

Get Contactable Inboxes

Get List of contactable Inboxes


/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/{id}/contactable_inboxes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactApi;

import java.io.File;
import java.util.*;

public class ContactApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactApi apiInstance = new ContactApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            contactable_inboxes result = apiInstance.contactableInboxesGet(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#contactableInboxesGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactApi;

public class ContactApiExample {

    public static void main(String[] args) {
        ContactApi apiInstance = new ContactApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            contactable_inboxes result = apiInstance.contactableInboxesGet(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactApi#contactableInboxesGet");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
BigDecimal *id = 8.14; // ID of the contact

ContactApi *apiInstance = [[ContactApi alloc] init];

// Get Contactable Inboxes
[apiInstance contactableInboxesGetWith:accountId
    id:id
              completionHandler: ^(contactable_inboxes output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 8.14; // {BigDecimal} ID of the contact


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactableInboxesGet(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactableInboxesGetExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the contact

            try
            {
                // Get Contactable Inboxes
                contactable_inboxes result = apiInstance.contactableInboxesGet(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactApi.contactableInboxesGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the contact

try {
    $result = $api_instance->contactableInboxesGet($accountId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactApi->contactableInboxesGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the contact

eval { 
    my $result = $api_instance->contactableInboxesGet(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactApi->contactableInboxesGet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the contact

try: 
    # Get Contactable Inboxes
    api_response = api_instance.contactable_inboxes_get(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactApi->contactableInboxesGet: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
BigDecimal
ID of the contact
Required

Responses

Status: 200 - Success

Status: 401 - Authentication error

Status: 422 - Incorrect payload


Contacts

contactConversations

Contact Conversations

Get conversations associated to that contact


/api/v1/accounts/{account_id}/contacts/{id}/conversations

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/{id}/conversations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            contact_conversations result = apiInstance.contactConversations(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactConversations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            contact_conversations result = apiInstance.contactConversations(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactConversations");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
BigDecimal *id = 8.14; // ID of the contact

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Contact Conversations
[apiInstance contactConversationsWith:accountId
    id:id
              completionHandler: ^(contact_conversations output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 8.14; // {BigDecimal} ID of the contact


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactConversations(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactConversationsExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the contact

            try
            {
                // Contact Conversations
                contact_conversations result = apiInstance.contactConversations(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactConversations: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the contact

try {
    $result = $api_instance->contactConversations($accountId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactConversations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the contact

eval { 
    my $result = $api_instance->contactConversations(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactConversations: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the contact

try: 
    # Contact Conversations
    api_response = api_instance.contact_conversations(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactConversations: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
BigDecimal
ID of the contact
Required

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Contact not found


contactCreate

Create Contact

Create a new Contact


/api/v1/accounts/{account_id}/contacts

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Contact_create data = ; // Contact_create | 
        try {
            extended_contact result = apiInstance.contactCreate(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactCreate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Contact_create data = ; // Contact_create | 
        try {
            extended_contact result = apiInstance.contactCreate(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactCreate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
Contact_create *data = ; // 

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Create Contact
[apiInstance contactCreateWith:accountId
    data:data
              completionHandler: ^(extended_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var data = ; // {Contact_create} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactCreate(accountId, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactCreateExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Contact_create(); // Contact_create | 

            try
            {
                // Create Contact
                extended_contact result = apiInstance.contactCreate(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactCreate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Contact_create | 

try {
    $result = $api_instance->contactCreate($accountId, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactCreate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Contact_create->new(); # Contact_create | 

eval { 
    my $result = $api_instance->contactCreate(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactCreate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Contact_create | 

try: 
    # Create Contact
    api_response = api_instance.contact_create(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactCreate: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 400 - Bad Request Error


contactDelete

Delete Contact


/api/v1/accounts/{account_id}/contacts/{id}

Usage and SDK Samples

curl -X DELETE -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            apiInstance.contactDelete(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            apiInstance.contactDelete(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactDelete");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
BigDecimal *id = 8.14; // ID of the contact

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Delete Contact
[apiInstance contactDeleteWith:accountId
    id:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 8.14; // {BigDecimal} ID of the contact


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.contactDelete(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactDeleteExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the contact

            try
            {
                // Delete Contact
                apiInstance.contactDelete(accountId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the contact

try {
    $api_instance->contactDelete($accountId, $id);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the contact

eval { 
    $api_instance->contactDelete(accountId => $accountId, id => $id);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the contact

try: 
    # Delete Contact
    api_instance.contact_delete(accountId, id)
except ApiException as e:
    print("Exception when calling ContactsApi->contactDelete: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
BigDecimal
ID of the contact
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Contact not found


contactDetails

Show Contact

Get a contact belonging to the account using ID


/api/v1/accounts/{account_id}/contacts/{id}

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            extended_contact result = apiInstance.contactDetails(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactDetails");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        try {
            extended_contact result = apiInstance.contactDetails(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactDetails");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
BigDecimal *id = 8.14; // ID of the contact

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Show Contact
[apiInstance contactDetailsWith:accountId
    id:id
              completionHandler: ^(extended_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 8.14; // {BigDecimal} ID of the contact


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactDetails(accountId, id, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactDetailsExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the contact

            try
            {
                // Show Contact
                extended_contact result = apiInstance.contactDetails(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactDetails: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the contact

try {
    $result = $api_instance->contactDetails($accountId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactDetails: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the contact

eval { 
    my $result = $api_instance->contactDetails(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactDetails: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the contact

try: 
    # Show Contact
    api_response = api_instance.contact_details(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactDetails: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
BigDecimal
ID of the contact
Required

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Contact not found


contactFilter

Contact Filter

Filter contacts with custom filter options and pagination


/api/v1/accounts/{account_id}/contacts/filter

Usage and SDK Samples

curl -X POST -H "api_access_token: [[apiKey]]" -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/filter?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: agentBotApiKey
        ApiKeyAuth agentBotApiKey = (ApiKeyAuth) defaultClient.getAuthentication("agentBotApiKey");
        agentBotApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //agentBotApiKey.setApiKeyPrefix("Token");

        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        array[payload] payload = ; // array[payload] | 
        Integer page = 56; // Integer | 
        try {
            contact_list result = apiInstance.contactFilter(accountId, payload, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        array[payload] payload = ; // array[payload] | 
        Integer page = 56; // Integer | 
        try {
            contact_list result = apiInstance.contactFilter(accountId, payload, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactFilter");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: agentBotApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
array[payload] *payload = ; // 
Integer *page = 56; //  (optional)

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Contact Filter
[apiInstance contactFilterWith:accountId
    payload:payload
    page:page
              completionHandler: ^(contact_list output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: agentBotApiKey
var agentBotApiKey = defaultClient.authentications['agentBotApiKey'];
agentBotApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//agentBotApiKey.apiKeyPrefix['api_access_token'] = "Token"

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var payload = ; // {array[payload]} 

var opts = { 
  'page': 56 // {Integer} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactFilter(accountId, payload, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactFilterExample
    {
        public void main()
        {
            
            // Configure API key authorization: agentBotApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var payload = new array[payload](); // array[payload] | 
            var page = 56;  // Integer |  (optional) 

            try
            {
                // Contact Filter
                contact_list result = apiInstance.contactFilter(accountId, payload, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactFilter: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: agentBotApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');
// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$payload = ; // array[payload] | 
$page = 56; // Integer | 

try {
    $result = $api_instance->contactFilter($accountId, $payload, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactFilter: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: agentBotApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";
# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $payload = [WWW::SwaggerClient::Object::array[payload]->new()]; # array[payload] | 
my $page = 56; # Integer | 

eval { 
    my $result = $api_instance->contactFilter(accountId => $accountId, payload => $payload, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactFilter: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: agentBotApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'
# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
payload =  # array[payload] | 
page = 56 # Integer |  (optional)

try: 
    # Contact Filter
    api_response = api_instance.contact_filter(accountId, payload, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactFilter: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
payload *
Query parameters
Name Description
page
Integer

Responses

Status: 200 - Success

Status: 400 - Bad Request Error


contactList

List Contacts

Listing all the resolved contacts with pagination (Page size = 15) . Resolved contacts are the ones with a value for identifier, email or phone number


/api/v1/accounts/{account_id}/contacts

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts?sort=&page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String sort = sort_example; // String | The attribute by which list should be sorted
        Integer page = 56; // Integer | The page parameter
        try {
            contact_list result = apiInstance.contactList(accountId, sort, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String sort = sort_example; // String | The attribute by which list should be sorted
        Integer page = 56; // Integer | The page parameter
        try {
            contact_list result = apiInstance.contactList(accountId, sort, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
String *sort = sort_example; // The attribute by which list should be sorted (optional)
Integer *page = 56; // The page parameter (optional) (default to 1)

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// List Contacts
[apiInstance contactListWith:accountId
    sort:sort
    page:page
              completionHandler: ^(contact_list output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var opts = { 
  'sort': sort_example, // {String} The attribute by which list should be sorted
  'page': 56 // {Integer} The page parameter
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactList(accountId, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactListExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var sort = sort_example;  // String | The attribute by which list should be sorted (optional) 
            var page = 56;  // Integer | The page parameter (optional)  (default to 1)

            try
            {
                // List Contacts
                contact_list result = apiInstance.contactList(accountId, sort, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$sort = sort_example; // String | The attribute by which list should be sorted
$page = 56; // Integer | The page parameter

try {
    $result = $api_instance->contactList($accountId, $sort, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $sort = sort_example; # String | The attribute by which list should be sorted
my $page = 56; # Integer | The page parameter

eval { 
    my $result = $api_instance->contactList(accountId => $accountId, sort => $sort, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactList: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
sort = sort_example # String | The attribute by which list should be sorted (optional)
page = 56 # Integer | The page parameter (optional) (default to 1)

try: 
    # List Contacts
    api_response = api_instance.contact_list(accountId, sort=sort, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactList: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
sort
String
The attribute by which list should be sorted
page
Integer
The page parameter

Responses

Status: 200 - Success

Status: 400 - Bad Request Error


contactSearch

Search Contacts

Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number


/api/v1/accounts/{account_id}/contacts/search

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/search?q=&sort=&page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String q = q_example; // String | Search using contact `name`, `identifier`, `email` or `phone number`
        String sort = sort_example; // String | The attribute by which list should be sorted
        Integer page = 56; // Integer | The page parameter
        try {
            inline_response_200_2 result = apiInstance.contactSearch(accountId, q, sort, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String q = q_example; // String | Search using contact `name`, `identifier`, `email` or `phone number`
        String sort = sort_example; // String | The attribute by which list should be sorted
        Integer page = 56; // Integer | The page parameter
        try {
            inline_response_200_2 result = apiInstance.contactSearch(accountId, q, sort, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactSearch");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
String *q = q_example; // Search using contact `name`, `identifier`, `email` or `phone number` (optional)
String *sort = sort_example; // The attribute by which list should be sorted (optional)
Integer *page = 56; // The page parameter (optional) (default to 1)

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Search Contacts
[apiInstance contactSearchWith:accountId
    q:q
    sort:sort
    page:page
              completionHandler: ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var opts = { 
  'q': q_example, // {String} Search using contact `name`, `identifier`, `email` or `phone number`
  'sort': sort_example, // {String} The attribute by which list should be sorted
  'page': 56 // {Integer} The page parameter
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactSearch(accountId, , opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactSearchExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var q = q_example;  // String | Search using contact `name`, `identifier`, `email` or `phone number` (optional) 
            var sort = sort_example;  // String | The attribute by which list should be sorted (optional) 
            var page = 56;  // Integer | The page parameter (optional)  (default to 1)

            try
            {
                // Search Contacts
                inline_response_200_2 result = apiInstance.contactSearch(accountId, q, sort, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$q = q_example; // String | Search using contact `name`, `identifier`, `email` or `phone number`
$sort = sort_example; // String | The attribute by which list should be sorted
$page = 56; // Integer | The page parameter

try {
    $result = $api_instance->contactSearch($accountId, $q, $sort, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $q = q_example; # String | Search using contact `name`, `identifier`, `email` or `phone number`
my $sort = sort_example; # String | The attribute by which list should be sorted
my $page = 56; # Integer | The page parameter

eval { 
    my $result = $api_instance->contactSearch(accountId => $accountId, q => $q, sort => $sort, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
q = q_example # String | Search using contact `name`, `identifier`, `email` or `phone number` (optional)
sort = sort_example # String | The attribute by which list should be sorted (optional)
page = 56 # Integer | The page parameter (optional) (default to 1)

try: 
    # Search Contacts
    api_response = api_instance.contact_search(accountId, q=q, sort=sort, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactSearch: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
q
String
Search using contact `name`, `identifier`, `email` or `phone number`
sort
String
The attribute by which list should be sorted
page
Integer
The page parameter

Responses

Status: 200 - Success

Status: 401 - Authentication error


contactUpdate

Update Contact

Update a contact belonging to the account using ID


/api/v1/accounts/{account_id}/contacts/{id}

Usage and SDK Samples

curl -X PUT -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/contacts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsApi;

import java.io.File;
import java.util.*;

public class ContactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: userApiKey
        ApiKeyAuth userApiKey = (ApiKeyAuth) defaultClient.getAuthentication("userApiKey");
        userApiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //userApiKey.setApiKeyPrefix("Token");

        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        Contact_update data = ; // Contact_update | 
        try {
            contact_base result = apiInstance.contactUpdate(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactUpdate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsApi;

public class ContactsApiExample {

    public static void main(String[] args) {
        ContactsApi apiInstance = new ContactsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the contact
        Contact_update data = ; // Contact_update | 
        try {
            contact_base result = apiInstance.contactUpdate(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsApi#contactUpdate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: userApiKey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"api_access_token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"api_access_token"];

Integer *accountId = 56; // The numeric ID of the account
BigDecimal *id = 8.14; // ID of the contact
Contact_update *data = ; // 

ContactsApi *apiInstance = [[ContactsApi alloc] init];

// Update Contact
[apiInstance contactUpdateWith:accountId
    id:id
    data:data
              completionHandler: ^(contact_base output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');
var defaultClient = Ooctopus.ApiClient.instance;

// Configure API key authorization: userApiKey
var userApiKey = defaultClient.authentications['userApiKey'];
userApiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//userApiKey.apiKeyPrefix['api_access_token'] = "Token"

var api = new Ooctopus.ContactsApi()

var accountId = 56; // {Integer} The numeric ID of the account

var id = 8.14; // {BigDecimal} ID of the contact

var data = ; // {Contact_update} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.contactUpdate(accountId, iddata, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class contactUpdateExample
    {
        public void main()
        {
            
            // Configure API key authorization: userApiKey
            Configuration.Default.ApiKey.Add("api_access_token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("api_access_token", "Bearer");

            var apiInstance = new ContactsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the contact
            var data = new Contact_update(); // Contact_update | 

            try
            {
                // Update Contact
                contact_base result = apiInstance.contactUpdate(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsApi.contactUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: userApiKey
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('api_access_token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_access_token', 'Bearer');

$api_instance = new Swagger\Client\Api\ContactsApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the contact
$data = ; // Contact_update | 

try {
    $result = $api_instance->contactUpdate($accountId, $id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsApi->contactUpdate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsApi;

# Configure API key authorization: userApiKey
$WWW::SwaggerClient::Configuration::api_key->{'api_access_token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_access_token'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ContactsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the contact
my $data = WWW::SwaggerClient::Object::Contact_update->new(); # Contact_update | 

eval { 
    my $result = $api_instance->contactUpdate(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsApi->contactUpdate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: userApiKey
swagger_client.configuration.api_key['api_access_token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['api_access_token'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ContactsApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the contact
data =  # Contact_update | 

try: 
    # Update Contact
    api_response = api_instance.contact_update(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsApi->contactUpdate: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
id*
BigDecimal
ID of the contact
Required
Body parameters
Name Description
data *

Responses

Status: 204 - Success

Status: 403 - Access denied

Status: 404 - Contact not found


ContactsAPI

createAContact

Create a contact

Create a contact


/public/api/v1/inboxes/{inbox_identifier}/contacts

Usage and SDK Samples

curl -X POST "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsAPIApi;

import java.io.File;
import java.util.*;

public class ContactsAPIApiExample {

    public static void main(String[] args) {
        
        ContactsAPIApi apiInstance = new ContactsAPIApi();
        String inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
        Public_contact_create_update_payload data = ; // Public_contact_create_update_payload | 
        try {
            public_contact result = apiInstance.createAContact(inboxIdentifier, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsAPIApi#createAContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsAPIApi;

public class ContactsAPIApiExample {

    public static void main(String[] args) {
        ContactsAPIApi apiInstance = new ContactsAPIApi();
        String inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
        Public_contact_create_update_payload data = ; // Public_contact_create_update_payload | 
        try {
            public_contact result = apiInstance.createAContact(inboxIdentifier, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsAPIApi#createAContact");
            e.printStackTrace();
        }
    }
}
String *inboxIdentifier = inboxIdentifier_example; // The identifier obtained from API inbox channel
Public_contact_create_update_payload *data = ; // 

ContactsAPIApi *apiInstance = [[ContactsAPIApi alloc] init];

// Create a contact
[apiInstance createAContactWith:inboxIdentifier
    data:data
              completionHandler: ^(public_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');

var api = new Ooctopus.ContactsAPIApi()

var inboxIdentifier = inboxIdentifier_example; // {String} The identifier obtained from API inbox channel

var data = ; // {Public_contact_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAContact(inboxIdentifier, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAContactExample
    {
        public void main()
        {
            
            var apiInstance = new ContactsAPIApi();
            var inboxIdentifier = inboxIdentifier_example;  // String | The identifier obtained from API inbox channel
            var data = new Public_contact_create_update_payload(); // Public_contact_create_update_payload | 

            try
            {
                // Create a contact
                public_contact result = apiInstance.createAContact(inboxIdentifier, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsAPIApi.createAContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ContactsAPIApi();
$inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
$data = ; // Public_contact_create_update_payload | 

try {
    $result = $api_instance->createAContact($inboxIdentifier, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsAPIApi->createAContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsAPIApi;

my $api_instance = WWW::SwaggerClient::ContactsAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $data = WWW::SwaggerClient::Object::Public_contact_create_update_payload->new(); # Public_contact_create_update_payload | 

eval { 
    my $result = $api_instance->createAContact(inboxIdentifier => $inboxIdentifier, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsAPIApi->createAContact: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ContactsAPIApi()
inboxIdentifier = inboxIdentifier_example # String | The identifier obtained from API inbox channel
data =  # Public_contact_create_update_payload | 

try: 
    # Create a contact
    api_response = api_instance.create_a_contact(inboxIdentifier, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsAPIApi->createAContact: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


getDetailsOfAContact

Get a contact

Get the details of a contact


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Usage and SDK Samples

curl -X GET "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ContactsAPIApi;

import java.io.File;
import java.util.*;

public class ContactsAPIApiExample {

    public static void main(String[] args) {
        
        ContactsAPIApi apiInstance = new ContactsAPIApi();
        String inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
        String contactIdentifier = contactIdentifier_example; // String | The source id of contact obtained on contact create
        try {
            public_contact result = apiInstance.getDetailsOfAContact(inboxIdentifier, contactIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsAPIApi#getDetailsOfAContact");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ContactsAPIApi;

public class ContactsAPIApiExample {

    public static void main(String[] args) {
        ContactsAPIApi apiInstance = new ContactsAPIApi();
        String inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
        String contactIdentifier = contactIdentifier_example; // String | The source id of contact obtained on contact create
        try {
            public_contact result = apiInstance.getDetailsOfAContact(inboxIdentifier, contactIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsAPIApi#getDetailsOfAContact");
            e.printStackTrace();
        }
    }
}
String *inboxIdentifier = inboxIdentifier_example; // The identifier obtained from API inbox channel
String *contactIdentifier = contactIdentifier_example; // The source id of contact obtained on contact create

ContactsAPIApi *apiInstance = [[ContactsAPIApi alloc] init];

// Get a contact
[apiInstance getDetailsOfAContactWith:inboxIdentifier
    contactIdentifier:contactIdentifier
              completionHandler: ^(public_contact output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');

var api = new Ooctopus.ContactsAPIApi()

var inboxIdentifier = inboxIdentifier_example; // {String} The identifier obtained from API inbox channel

var contactIdentifier = contactIdentifier_example; // {String} The source id of contact obtained on contact create


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDetailsOfAContact(inboxIdentifier, contactIdentifier, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDetailsOfAContactExample
    {
        public void main()
        {
            
            var apiInstance = new ContactsAPIApi();
            var inboxIdentifier = inboxIdentifier_example;  // String | The identifier obtained from API inbox channel
            var contactIdentifier = contactIdentifier_example;  // String | The source id of contact obtained on contact create

            try
            {
                // Get a contact
                public_contact result = apiInstance.getDetailsOfAContact(inboxIdentifier, contactIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsAPIApi.getDetailsOfAContact: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ContactsAPIApi();
$inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
$contactIdentifier = contactIdentifier_example; // String | The source id of contact obtained on contact create

try {
    $result = $api_instance->getDetailsOfAContact($inboxIdentifier, $contactIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsAPIApi->getDetailsOfAContact: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ContactsAPIApi;

my $api_instance = WWW::SwaggerClient::ContactsAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $contactIdentifier = contactIdentifier_examp