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_example; # String | The source id of contact obtained on contact create

eval { 
    my $result = $api_instance->getDetailsOfAContact(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsAPIApi->getDetailsOfAContact: $@\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
contactIdentifier = contactIdentifier_example # String | The source id of contact obtained on contact create

try: 
    # Get a contact
    api_response = api_instance.get_details_of_a_contact(inboxIdentifier, contactIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsAPIApi->getDetailsOfAContact: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given contact does not exist


updateAContact

Update a contact

Update a contact's attributes


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

Usage and SDK Samples

curl -X PATCH "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
        Public_contact_create_update_payload data = ; // Public_contact_create_update_payload | 
        try {
            public_contact result = apiInstance.updateAContact(inboxIdentifier, contactIdentifier, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsAPIApi#updateAContact");
            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
        Public_contact_create_update_payload data = ; // Public_contact_create_update_payload | 
        try {
            public_contact result = apiInstance.updateAContact(inboxIdentifier, contactIdentifier, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactsAPIApi#updateAContact");
            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
Public_contact_create_update_payload *data = ; // 

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

// Update a contact
[apiInstance updateAContactWith:inboxIdentifier
    contactIdentifier:contactIdentifier
    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 contactIdentifier = contactIdentifier_example; // {String} The source id of contact obtained on contact create

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.updateAContact(inboxIdentifier, contactIdentifier, data, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAContactExample
    {
        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
            var data = new Public_contact_create_update_payload(); // Public_contact_create_update_payload | 

            try
            {
                // Update a contact
                public_contact result = apiInstance.updateAContact(inboxIdentifier, contactIdentifier, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ContactsAPIApi.updateAContact: " + 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
$data = ; // Public_contact_create_update_payload | 

try {
    $result = $api_instance->updateAContact($inboxIdentifier, $contactIdentifier, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactsAPIApi->updateAContact: ', $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_example; # String | The source id of contact obtained on contact create
my $data = WWW::SwaggerClient::Object::Public_contact_create_update_payload->new(); # Public_contact_create_update_payload | 

eval { 
    my $result = $api_instance->updateAContact(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContactsAPIApi->updateAContact: $@\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
contactIdentifier = contactIdentifier_example # String | The source id of contact obtained on contact create
data =  # Public_contact_create_update_payload | 

try: 
    # Update a contact
    api_response = api_instance.update_a_contact(inboxIdentifier, contactIdentifier, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContactsAPIApi->updateAContact: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


ConversationAssignment

assignAConversation

Assign Conversation

Assign a conversation to an agent or a team


/api/v1/accounts/{account_id}/conversations/{conversation_id}/assignments

Usage and SDK Samples

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

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

public class ConversationAssignmentApiExample {

    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");

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

public class ConversationAssignmentApiExample {

    public static void main(String[] args) {
        ConversationAssignmentApi apiInstance = new ConversationAssignmentApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Data_7 data = ; // Data_7 | 
        try {
            user result = apiInstance.assignAConversation(accountId, conversationId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationAssignmentApi#assignAConversation");
            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 *conversationId = 56; // The numeric ID of the conversation
Data_7 *data = ; // 

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

// Assign Conversation
[apiInstance assignAConversationWith:accountId
    conversationId:conversationId
    data:data
              completionHandler: ^(user 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.ConversationAssignmentApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation

var data = ; // {Data_7} 


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

namespace Example
{
    public class assignAConversationExample
    {
        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 ConversationAssignmentApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation
            var data = new Data_7(); // Data_7 | 

            try
            {
                // Assign Conversation
                user result = apiInstance.assignAConversation(accountId, conversationId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationAssignmentApi.assignAConversation: " + 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\ConversationAssignmentApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation
$data = ; // Data_7 | 

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

# 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::ConversationAssignmentApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $data = WWW::SwaggerClient::Object::Data_7->new(); # Data_7 | 

eval { 
    my $result = $api_instance->assignAConversation(accountId => $accountId, conversationId => $conversationId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationAssignmentApi->assignAConversation: $@\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.ConversationAssignmentApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation
data =  # Data_7 | 

try: 
    # Assign Conversation
    api_response = api_instance.assign_a_conversation(accountId, conversationId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationAssignmentApi->assignAConversation: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Conversation not found


ConversationLabels

conversationAddLabels

Add Labels

Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.


/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels

Usage and SDK Samples

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

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

public class ConversationLabelsApiExample {

    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");

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

public class ConversationLabelsApiExample {

    public static void main(String[] args) {
        ConversationLabelsApi apiInstance = new ConversationLabelsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Data_8 data = ; // Data_8 | 
        try {
            conversation_labels result = apiInstance.conversationAddLabels(accountId, conversationId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationLabelsApi#conversationAddLabels");
            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 *conversationId = 56; // The numeric ID of the conversation
Data_8 *data = ; // 

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

// Add Labels
[apiInstance conversationAddLabelsWith:accountId
    conversationId:conversationId
    data:data
              completionHandler: ^(conversation_labels 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.ConversationLabelsApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation

var data = ; // {Data_8} 


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

namespace Example
{
    public class conversationAddLabelsExample
    {
        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 ConversationLabelsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation
            var data = new Data_8(); // Data_8 | 

            try
            {
                // Add Labels
                conversation_labels result = apiInstance.conversationAddLabels(accountId, conversationId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationLabelsApi.conversationAddLabels: " + 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\ConversationLabelsApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation
$data = ; // Data_8 | 

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

# 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::ConversationLabelsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $data = WWW::SwaggerClient::Object::Data_8->new(); # Data_8 | 

eval { 
    my $result = $api_instance->conversationAddLabels(accountId => $accountId, conversationId => $conversationId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationLabelsApi->conversationAddLabels: $@\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.ConversationLabelsApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation
data =  # Data_8 | 

try: 
    # Add Labels
    api_response = api_instance.conversation_add_labels(accountId, conversationId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationLabelsApi->conversationAddLabels: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Conversation not found


listAllLabelsOfAConversation

List Labels

Lists all the labels of a conversation


/api/v1/accounts/{account_id}/conversations/{conversation_id}/labels

Usage and SDK Samples

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

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

public class ConversationLabelsApiExample {

    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");

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

public class ConversationLabelsApiExample {

    public static void main(String[] args) {
        ConversationLabelsApi apiInstance = new ConversationLabelsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        try {
            conversation_labels result = apiInstance.listAllLabelsOfAConversation(accountId, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationLabelsApi#listAllLabelsOfAConversation");
            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 *conversationId = 56; // The numeric ID of the conversation

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

// List Labels
[apiInstance listAllLabelsOfAConversationWith:accountId
    conversationId:conversationId
              completionHandler: ^(conversation_labels 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.ConversationLabelsApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation


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

namespace Example
{
    public class listAllLabelsOfAConversationExample
    {
        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 ConversationLabelsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation

            try
            {
                // List Labels
                conversation_labels result = apiInstance.listAllLabelsOfAConversation(accountId, conversationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationLabelsApi.listAllLabelsOfAConversation: " + 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\ConversationLabelsApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation

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

# 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::ConversationLabelsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation

eval { 
    my $result = $api_instance->listAllLabelsOfAConversation(accountId => $accountId, conversationId => $conversationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationLabelsApi->listAllLabelsOfAConversation: $@\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.ConversationLabelsApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation

try: 
    # List Labels
    api_response = api_instance.list_all_labels_of_a_conversation(accountId, conversationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationLabelsApi->listAllLabelsOfAConversation: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Conversation not found


Conversations

conversationFilter

Conversations Filter

Filter conversations with custom filter options and pagination


/api/v1/accounts/{account_id}/conversations/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}/conversations/filter?page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

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

public class ConversationsApiExample {

    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");

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

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        array[payload] payload = ; // array[payload] | 
        Integer page = 56; // Integer | 
        try {
            conversation_list result = apiInstance.conversationFilter(accountId, payload, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationFilter");
            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)

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

// Conversations Filter
[apiInstance conversationFilterWith:accountId
    payload:payload
    page:page
              completionHandler: ^(conversation_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.ConversationsApi()

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.conversationFilter(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 conversationFilterExample
    {
        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 ConversationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var payload = new array[payload](); // array[payload] | 
            var page = 56;  // Integer |  (optional) 

            try
            {
                // Conversations Filter
                conversation_list result = apiInstance.conversationFilter(accountId, payload, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.conversationFilter: " + 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\ConversationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$payload = ; // array[payload] | 
$page = 56; // Integer | 

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

# 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::ConversationsApi->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->conversationFilter(accountId => $accountId, payload => $payload, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->conversationFilter: $@\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.ConversationsApi()
accountId = 56 # Integer | The numeric ID of the account
payload =  # array[payload] | 
page = 56 # Integer |  (optional)

try: 
    # Conversations Filter
    api_response = api_instance.conversation_filter(accountId, payload, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->conversationFilter: %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


conversationList

Conversations List

List all the conversations with pagination


/api/v1/accounts/{account_id}/conversations

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/conversations?assignee_type=&status=&q=&inbox_id=&team_id=&labels=&page="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

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

public class ConversationsApiExample {

    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");

        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String assigneeType = assigneeType_example; // String | Filter conversations by assignee type.
        String status = status_example; // String | Filter by conversation status.
        String q = q_example; // String | Filters conversations with messages containing the search term
        Integer inboxId = 56; // Integer | 
        Integer teamId = 56; // Integer | 
        array[String] labels = ; // array[String] | 
        Integer page = 56; // Integer | paginate through conversations
        try {
            conversation_list result = apiInstance.conversationList(accountId, assigneeType, status, q, inboxId, teamId, labels, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String assigneeType = assigneeType_example; // String | Filter conversations by assignee type.
        String status = status_example; // String | Filter by conversation status.
        String q = q_example; // String | Filters conversations with messages containing the search term
        Integer inboxId = 56; // Integer | 
        Integer teamId = 56; // Integer | 
        array[String] labels = ; // array[String] | 
        Integer page = 56; // Integer | paginate through conversations
        try {
            conversation_list result = apiInstance.conversationList(accountId, assigneeType, status, q, inboxId, teamId, labels, page);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationList");
            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 *assigneeType = assigneeType_example; // Filter conversations by assignee type. (optional) (default to all)
String *status = status_example; // Filter by conversation status. (optional) (default to open)
String *q = q_example; // Filters conversations with messages containing the search term (optional)
Integer *inboxId = 56; //  (optional)
Integer *teamId = 56; //  (optional)
array[String] *labels = ; //  (optional)
Integer *page = 56; // paginate through conversations (optional) (default to 1)

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

// Conversations List
[apiInstance conversationListWith:accountId
    assigneeType:assigneeType
    status:status
    q:q
    inboxId:inboxId
    teamId:teamId
    labels:labels
    page:page
              completionHandler: ^(conversation_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.ConversationsApi()

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

var opts = { 
  'assigneeType': assigneeType_example, // {String} Filter conversations by assignee type.
  'status': status_example, // {String} Filter by conversation status.
  'q': q_example, // {String} Filters conversations with messages containing the search term
  'inboxId': 56, // {Integer} 
  'teamId': 56, // {Integer} 
  'labels': , // {array[String]} 
  'page': 56 // {Integer} paginate through conversations
};

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

namespace Example
{
    public class conversationListExample
    {
        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 ConversationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var assigneeType = assigneeType_example;  // String | Filter conversations by assignee type. (optional)  (default to all)
            var status = status_example;  // String | Filter by conversation status. (optional)  (default to open)
            var q = q_example;  // String | Filters conversations with messages containing the search term (optional) 
            var inboxId = 56;  // Integer |  (optional) 
            var teamId = 56;  // Integer |  (optional) 
            var labels = new array[String](); // array[String] |  (optional) 
            var page = 56;  // Integer | paginate through conversations (optional)  (default to 1)

            try
            {
                // Conversations List
                conversation_list result = apiInstance.conversationList(accountId, assigneeType, status, q, inboxId, teamId, labels, page);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.conversationList: " + 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\ConversationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$assigneeType = assigneeType_example; // String | Filter conversations by assignee type.
$status = status_example; // String | Filter by conversation status.
$q = q_example; // String | Filters conversations with messages containing the search term
$inboxId = 56; // Integer | 
$teamId = 56; // Integer | 
$labels = ; // array[String] | 
$page = 56; // Integer | paginate through conversations

try {
    $result = $api_instance->conversationList($accountId, $assigneeType, $status, $q, $inboxId, $teamId, $labels, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;

# 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::ConversationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $assigneeType = assigneeType_example; # String | Filter conversations by assignee type.
my $status = status_example; # String | Filter by conversation status.
my $q = q_example; # String | Filters conversations with messages containing the search term
my $inboxId = 56; # Integer | 
my $teamId = 56; # Integer | 
my $labels = []; # array[String] | 
my $page = 56; # Integer | paginate through conversations

eval { 
    my $result = $api_instance->conversationList(accountId => $accountId, assigneeType => $assigneeType, status => $status, q => $q, inboxId => $inboxId, teamId => $teamId, labels => $labels, page => $page);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->conversationList: $@\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.ConversationsApi()
accountId = 56 # Integer | The numeric ID of the account
assigneeType = assigneeType_example # String | Filter conversations by assignee type. (optional) (default to all)
status = status_example # String | Filter by conversation status. (optional) (default to open)
q = q_example # String | Filters conversations with messages containing the search term (optional)
inboxId = 56 # Integer |  (optional)
teamId = 56 # Integer |  (optional)
labels =  # array[String] |  (optional)
page = 56 # Integer | paginate through conversations (optional) (default to 1)

try: 
    # Conversations List
    api_response = api_instance.conversation_list(accountId, assigneeType=assigneeType, status=status, q=q, inboxId=inboxId, teamId=teamId, labels=labels, page=page)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->conversationList: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
assignee_type
String
Filter conversations by assignee type.
status
String
Filter by conversation status.
q
String
Filters conversations with messages containing the search term
inbox_id
Integer
team_id
Integer
labels
array[String]
page
Integer
paginate through conversations

Responses

Status: 200 - Success

Status: 400 - Bad Request Error


conversationListMeta

Get Conversation Counts

Get open, unassigned and all Conversation counts


/api/v1/accounts/{account_id}/conversations/meta

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v1/accounts/{account_id}/conversations/meta?status=&q=&inbox_id=&team_id=&labels="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

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

public class ConversationsApiExample {

    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");

        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String status = status_example; // String | Filter by conversation status.
        String q = q_example; // String | Filters conversations with messages containing the search term
        Integer inboxId = 56; // Integer | 
        Integer teamId = 56; // Integer | 
        array[String] labels = ; // array[String] | 
        try {
            inline_response_200_3 result = apiInstance.conversationListMeta(accountId, status, q, inboxId, teamId, labels);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationListMeta");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsApi;

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String status = status_example; // String | Filter by conversation status.
        String q = q_example; // String | Filters conversations with messages containing the search term
        Integer inboxId = 56; // Integer | 
        Integer teamId = 56; // Integer | 
        array[String] labels = ; // array[String] | 
        try {
            inline_response_200_3 result = apiInstance.conversationListMeta(accountId, status, q, inboxId, teamId, labels);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#conversationListMeta");
            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 *status = status_example; // Filter by conversation status. (optional) (default to open)
String *q = q_example; // Filters conversations with messages containing the search term (optional)
Integer *inboxId = 56; //  (optional)
Integer *teamId = 56; //  (optional)
array[String] *labels = ; //  (optional)

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

// Get Conversation Counts
[apiInstance conversationListMetaWith:accountId
    status:status
    q:q
    inboxId:inboxId
    teamId:teamId
    labels:labels
              completionHandler: ^(inline_response_200_3 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.ConversationsApi()

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

var opts = { 
  'status': status_example, // {String} Filter by conversation status.
  'q': q_example, // {String} Filters conversations with messages containing the search term
  'inboxId': 56, // {Integer} 
  'teamId': 56, // {Integer} 
  'labels':  // {array[String]} 
};

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

namespace Example
{
    public class conversationListMetaExample
    {
        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 ConversationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var status = status_example;  // String | Filter by conversation status. (optional)  (default to open)
            var q = q_example;  // String | Filters conversations with messages containing the search term (optional) 
            var inboxId = 56;  // Integer |  (optional) 
            var teamId = 56;  // Integer |  (optional) 
            var labels = new array[String](); // array[String] |  (optional) 

            try
            {
                // Get Conversation Counts
                inline_response_200_3 result = apiInstance.conversationListMeta(accountId, status, q, inboxId, teamId, labels);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.conversationListMeta: " + 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\ConversationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$status = status_example; // String | Filter by conversation status.
$q = q_example; // String | Filters conversations with messages containing the search term
$inboxId = 56; // Integer | 
$teamId = 56; // Integer | 
$labels = ; // array[String] | 

try {
    $result = $api_instance->conversationListMeta($accountId, $status, $q, $inboxId, $teamId, $labels);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsApi->conversationListMeta: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsApi;

# 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::ConversationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $status = status_example; # String | Filter by conversation status.
my $q = q_example; # String | Filters conversations with messages containing the search term
my $inboxId = 56; # Integer | 
my $teamId = 56; # Integer | 
my $labels = []; # array[String] | 

eval { 
    my $result = $api_instance->conversationListMeta(accountId => $accountId, status => $status, q => $q, inboxId => $inboxId, teamId => $teamId, labels => $labels);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->conversationListMeta: $@\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.ConversationsApi()
accountId = 56 # Integer | The numeric ID of the account
status = status_example # String | Filter by conversation status. (optional) (default to open)
q = q_example # String | Filters conversations with messages containing the search term (optional)
inboxId = 56 # Integer |  (optional)
teamId = 56 # Integer |  (optional)
labels =  # array[String] |  (optional)

try: 
    # Get Conversation Counts
    api_response = api_instance.conversation_list_meta(accountId, status=status, q=q, inboxId=inboxId, teamId=teamId, labels=labels)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->conversationListMeta: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
status
String
Filter by conversation status.
q
String
Filters conversations with messages containing the search term
inbox_id
Integer
team_id
Integer
labels
array[String]

Responses

Status: 200 - Success

Status: 400 - Bad Request Error


getDetailsOfAConversation

Conversation Details

Get all details regarding a conversation with all messages in the conversation


/api/v1/accounts/{account_id}/conversations/{conversation_id}

Usage and SDK Samples

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

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

public class ConversationsApiExample {

    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");

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

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        try {
            conversation_show result = apiInstance.getDetailsOfAConversation(accountId, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#getDetailsOfAConversation");
            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 *conversationId = 56; // The numeric ID of the conversation

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

// Conversation Details
[apiInstance getDetailsOfAConversationWith:accountId
    conversationId:conversationId
              completionHandler: ^(conversation_show 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.ConversationsApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation


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

namespace Example
{
    public class getDetailsOfAConversationExample
    {
        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 ConversationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation

            try
            {
                // Conversation Details
                conversation_show result = apiInstance.getDetailsOfAConversation(accountId, conversationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.getDetailsOfAConversation: " + 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\ConversationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation

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

# 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::ConversationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation

eval { 
    my $result = $api_instance->getDetailsOfAConversation(accountId => $accountId, conversationId => $conversationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->getDetailsOfAConversation: $@\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.ConversationsApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation

try: 
    # Conversation Details
    api_response = api_instance.get_details_of_a_conversation(accountId, conversationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->getDetailsOfAConversation: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Conversation not found


newConversation

Create New Conversation

Creating a conversation in Ooctopus™ requires a source id.


/api/v1/accounts/{account_id}/conversations

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}/conversations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

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

public class ConversationsApiExample {

    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");

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

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_5 data = ; // Data_5 | 
        try {
            inline_response_200_4 result = apiInstance.newConversation(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#newConversation");
            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
Data_5 *data = ; // 

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

// Create New Conversation
[apiInstance newConversationWith:accountId
    data:data
              completionHandler: ^(inline_response_200_4 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.ConversationsApi()

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

var data = ; // {Data_5} 


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

namespace Example
{
    public class newConversationExample
    {
        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 ConversationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data_5(); // Data_5 | 

            try
            {
                // Create New Conversation
                inline_response_200_4 result = apiInstance.newConversation(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.newConversation: " + 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\ConversationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data_5 | 

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

# 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::ConversationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data_5->new(); # Data_5 | 

eval { 
    my $result = $api_instance->newConversation(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->newConversation: $@\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.ConversationsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data_5 | 

try: 
    # Create New Conversation
    api_response = api_instance.new_conversation(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->newConversation: %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


toggleStatusOfAConversation

Toggle Status

Toggles the status of the conversation between open and resolved


/api/v1/accounts/{account_id}/conversations/{conversation_id}/toggle_status

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}/conversations/{conversation_id}/toggle_status"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsApi;

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

public class ConversationsApiExample {

    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");

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

public class ConversationsApiExample {

    public static void main(String[] args) {
        ConversationsApi apiInstance = new ConversationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Data_6 data = ; // Data_6 | 
        try {
            conversation_status_toggle result = apiInstance.toggleStatusOfAConversation(accountId, conversationId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsApi#toggleStatusOfAConversation");
            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
Integer *conversationId = 56; // The numeric ID of the conversation
Data_6 *data = ; // 

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

// Toggle Status
[apiInstance toggleStatusOfAConversationWith:accountId
    conversationId:conversationId
    data:data
              completionHandler: ^(conversation_status_toggle 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.ConversationsApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation

var data = ; // {Data_6} 


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

namespace Example
{
    public class toggleStatusOfAConversationExample
    {
        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 ConversationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation
            var data = new Data_6(); // Data_6 | 

            try
            {
                // Toggle Status
                conversation_status_toggle result = apiInstance.toggleStatusOfAConversation(accountId, conversationId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsApi.toggleStatusOfAConversation: " + 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\ConversationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation
$data = ; // Data_6 | 

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

# 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::ConversationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $data = WWW::SwaggerClient::Object::Data_6->new(); # Data_6 | 

eval { 
    my $result = $api_instance->toggleStatusOfAConversation(accountId => $accountId, conversationId => $conversationId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsApi->toggleStatusOfAConversation: $@\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.ConversationsApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation
data =  # Data_6 | 

try: 
    # Toggle Status
    api_response = api_instance.toggle_status_of_a_conversation(accountId, conversationId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsApi->toggleStatusOfAConversation: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Conversation not found


ConversationsAPI

createAConversation

Create a conversation

Create a conversation


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations

Usage and SDK Samples

curl -X POST "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsAPIApi;

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

public class ConversationsAPIApiExample {

    public static void main(String[] args) {
        
        ConversationsAPIApi apiInstance = new ConversationsAPIApi();
        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_conversation result = apiInstance.createAConversation(inboxIdentifier, contactIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsAPIApi#createAConversation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsAPIApi;

public class ConversationsAPIApiExample {

    public static void main(String[] args) {
        ConversationsAPIApi apiInstance = new ConversationsAPIApi();
        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_conversation result = apiInstance.createAConversation(inboxIdentifier, contactIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsAPIApi#createAConversation");
            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

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

// Create a conversation
[apiInstance createAConversationWith:inboxIdentifier
    contactIdentifier:contactIdentifier
              completionHandler: ^(public_conversation output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');

var api = new Ooctopus.ConversationsAPIApi()

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.createAConversation(inboxIdentifier, contactIdentifier, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAConversationExample
    {
        public void main()
        {
            
            var apiInstance = new ConversationsAPIApi();
            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
            {
                // Create a conversation
                public_conversation result = apiInstance.createAConversation(inboxIdentifier, contactIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsAPIApi.createAConversation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ConversationsAPIApi();
$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->createAConversation($inboxIdentifier, $contactIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsAPIApi->createAConversation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsAPIApi;

my $api_instance = WWW::SwaggerClient::ConversationsAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $contactIdentifier = contactIdentifier_example; # String | The source id of contact obtained on contact create

eval { 
    my $result = $api_instance->createAConversation(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsAPIApi->createAConversation: $@\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.ConversationsAPIApi()
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: 
    # Create a conversation
    api_response = api_instance.create_a_conversation(inboxIdentifier, contactIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsAPIApi->createAConversation: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized


listAllContactConversations

List all conversations

List all conversations for the contact


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConversationsAPIApi;

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

public class ConversationsAPIApiExample {

    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");

        ConversationsAPIApi apiInstance = new ConversationsAPIApi();
        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 {
            array[public_conversation] result = apiInstance.listAllContactConversations(inboxIdentifier, contactIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsAPIApi#listAllContactConversations");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConversationsAPIApi;

public class ConversationsAPIApiExample {

    public static void main(String[] args) {
        ConversationsAPIApi apiInstance = new ConversationsAPIApi();
        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 {
            array[public_conversation] result = apiInstance.listAllContactConversations(inboxIdentifier, contactIdentifier);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConversationsAPIApi#listAllContactConversations");
            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"];

String *inboxIdentifier = inboxIdentifier_example; // The identifier obtained from API inbox channel
String *contactIdentifier = contactIdentifier_example; // The source id of contact obtained on contact create

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

// List all conversations
[apiInstance listAllContactConversationsWith:inboxIdentifier
    contactIdentifier:contactIdentifier
              completionHandler: ^(array[public_conversation] 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.ConversationsAPIApi()

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.listAllContactConversations(inboxIdentifier, contactIdentifier, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllContactConversationsExample
    {
        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 ConversationsAPIApi();
            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
            {
                // List all conversations
                array[public_conversation] result = apiInstance.listAllContactConversations(inboxIdentifier, contactIdentifier);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConversationsAPIApi.listAllContactConversations: " + 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\ConversationsAPIApi();
$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->listAllContactConversations($inboxIdentifier, $contactIdentifier);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConversationsAPIApi->listAllContactConversations: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConversationsAPIApi;

# 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::ConversationsAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $contactIdentifier = contactIdentifier_example; # String | The source id of contact obtained on contact create

eval { 
    my $result = $api_instance->listAllContactConversations(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConversationsAPIApi->listAllContactConversations: $@\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.ConversationsAPIApi()
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: 
    # List all conversations
    api_response = api_instance.list_all_contact_conversations(inboxIdentifier, contactIdentifier)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConversationsAPIApi->listAllContactConversations: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized


CustomAttributes

addNewCustomAttributeToAccount

Add a new custom attribute

Add a new custom attribute to account


/api/v1/accounts/{account_id}/custom_attribute_definitions

Usage and SDK Samples

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

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

public class CustomAttributesApiExample {

    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");

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

public class CustomAttributesApiExample {

    public static void main(String[] args) {
        CustomAttributesApi apiInstance = new CustomAttributesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Custom_attribute_create_update_payload data = ; // Custom_attribute_create_update_payload | 
        try {
            custom_attribute result = apiInstance.addNewCustomAttributeToAccount(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomAttributesApi#addNewCustomAttributeToAccount");
            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
Custom_attribute_create_update_payload *data = ; // 

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

// Add a new custom attribute
[apiInstance addNewCustomAttributeToAccountWith:accountId
    data:data
              completionHandler: ^(custom_attribute 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.CustomAttributesApi()

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

var data = ; // {Custom_attribute_create_update_payload} 


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

namespace Example
{
    public class addNewCustomAttributeToAccountExample
    {
        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 CustomAttributesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Custom_attribute_create_update_payload(); // Custom_attribute_create_update_payload | 

            try
            {
                // Add a new custom attribute
                custom_attribute result = apiInstance.addNewCustomAttributeToAccount(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomAttributesApi.addNewCustomAttributeToAccount: " + 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\CustomAttributesApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Custom_attribute_create_update_payload | 

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

# 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::CustomAttributesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Custom_attribute_create_update_payload->new(); # Custom_attribute_create_update_payload | 

eval { 
    my $result = $api_instance->addNewCustomAttributeToAccount(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomAttributesApi->addNewCustomAttributeToAccount: $@\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.CustomAttributesApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Custom_attribute_create_update_payload | 

try: 
    # Add a new custom attribute
    api_response = api_instance.add_new_custom_attribute_to_account(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomAttributesApi->addNewCustomAttributeToAccount: %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


deleteCustomAttributeFromAccount

Remove a custom attribute from account

Remove a custom attribute from account


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

Usage and SDK Samples

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

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

public class CustomAttributesApiExample {

    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");

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

public class CustomAttributesApiExample {

    public static void main(String[] args) {
        CustomAttributesApi apiInstance = new CustomAttributesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the custom attribute to be deleted
        try {
            apiInstance.deleteCustomAttributeFromAccount(accountId, id);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomAttributesApi#deleteCustomAttributeFromAccount");
            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 custom attribute to be deleted

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

// Remove a custom attribute from account
[apiInstance deleteCustomAttributeFromAccountWith: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.CustomAttributesApi()

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

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


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

namespace Example
{
    public class deleteCustomAttributeFromAccountExample
    {
        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 CustomAttributesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the custom attribute to be deleted

            try
            {
                // Remove a custom attribute from account
                apiInstance.deleteCustomAttributeFromAccount(accountId, id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomAttributesApi.deleteCustomAttributeFromAccount: " + 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\CustomAttributesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the custom attribute to be deleted

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

# 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::CustomAttributesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the custom attribute to be deleted

eval { 
    $api_instance->deleteCustomAttributeFromAccount(accountId => $accountId, id => $id);
};
if ($@) {
    warn "Exception when calling CustomAttributesApi->deleteCustomAttributeFromAccount: $@\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.CustomAttributesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the custom attribute to be deleted

try: 
    # Remove a custom attribute from account
    api_instance.delete_custom_attribute_from_account(accountId, id)
except ApiException as e:
    print("Exception when calling CustomAttributesApi->deleteCustomAttributeFromAccount: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Custom attribute not found


getAccountCustomAttribute

List all custom attributes in an account

Get details of custom attributes in an Account


/api/v1/accounts/{account_id}/custom_attribute_definitions

Usage and SDK Samples

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

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

public class CustomAttributesApiExample {

    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");

        CustomAttributesApi apiInstance = new CustomAttributesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String attributeModel = attributeModel_example; // String | conversation_attribute(0)/contact_attribute(1)
        try {
            array[custom_attribute] result = apiInstance.getAccountCustomAttribute(accountId, attributeModel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomAttributesApi#getAccountCustomAttribute");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomAttributesApi;

public class CustomAttributesApiExample {

    public static void main(String[] args) {
        CustomAttributesApi apiInstance = new CustomAttributesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String attributeModel = attributeModel_example; // String | conversation_attribute(0)/contact_attribute(1)
        try {
            array[custom_attribute] result = apiInstance.getAccountCustomAttribute(accountId, attributeModel);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomAttributesApi#getAccountCustomAttribute");
            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 *attributeModel = attributeModel_example; // conversation_attribute(0)/contact_attribute(1)

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

// List all custom attributes in an account
[apiInstance getAccountCustomAttributeWith:accountId
    attributeModel:attributeModel
              completionHandler: ^(array[custom_attribute] 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.CustomAttributesApi()

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

var attributeModel = attributeModel_example; // {String} conversation_attribute(0)/contact_attribute(1)


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

namespace Example
{
    public class getAccountCustomAttributeExample
    {
        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 CustomAttributesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var attributeModel = attributeModel_example;  // String | conversation_attribute(0)/contact_attribute(1)

            try
            {
                // List all custom attributes in an account
                array[custom_attribute] result = apiInstance.getAccountCustomAttribute(accountId, attributeModel);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomAttributesApi.getAccountCustomAttribute: " + 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\CustomAttributesApi();
$accountId = 56; // Integer | The numeric ID of the account
$attributeModel = attributeModel_example; // String | conversation_attribute(0)/contact_attribute(1)

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

# 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::CustomAttributesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $attributeModel = attributeModel_example; # String | conversation_attribute(0)/contact_attribute(1)

eval { 
    my $result = $api_instance->getAccountCustomAttribute(accountId => $accountId, attributeModel => $attributeModel);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomAttributesApi->getAccountCustomAttribute: $@\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.CustomAttributesApi()
accountId = 56 # Integer | The numeric ID of the account
attributeModel = attributeModel_example # String | conversation_attribute(0)/contact_attribute(1)

try: 
    # List all custom attributes in an account
    api_response = api_instance.get_account_custom_attribute(accountId, attributeModel)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomAttributesApi->getAccountCustomAttribute: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
attribute_model*
String
conversation_attribute(0)/contact_attribute(1)
Required

Responses

Status: 200 - Success

Status: 403 - Access denied


getDetailsOfASingleCustomAttribute

Get a custom attribute details

Get the details of a custom attribute in the account


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

Usage and SDK Samples

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

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

public class CustomAttributesApiExample {

    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");

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

public class CustomAttributesApiExample {

    public static void main(String[] args) {
        CustomAttributesApi apiInstance = new CustomAttributesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the custom attribute to be updated.
        try {
            custom_attribute result = apiInstance.getDetailsOfASingleCustomAttribute(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomAttributesApi#getDetailsOfASingleCustomAttribute");
            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 custom attribute to be updated.

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

// Get a custom attribute details
[apiInstance getDetailsOfASingleCustomAttributeWith:accountId
    id:id
              completionHandler: ^(custom_attribute 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.CustomAttributesApi()

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

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


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

namespace Example
{
    public class getDetailsOfASingleCustomAttributeExample
    {
        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 CustomAttributesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the custom attribute to be updated.

            try
            {
                // Get a custom attribute details
                custom_attribute result = apiInstance.getDetailsOfASingleCustomAttribute(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomAttributesApi.getDetailsOfASingleCustomAttribute: " + 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\CustomAttributesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the custom attribute to be updated.

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

# 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::CustomAttributesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the custom attribute to be updated.

eval { 
    my $result = $api_instance->getDetailsOfASingleCustomAttribute(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomAttributesApi->getDetailsOfASingleCustomAttribute: $@\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.CustomAttributesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the custom attribute to be updated.

try: 
    # Get a custom attribute details
    api_response = api_instance.get_details_of_a_single_custom_attribute(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomAttributesApi->getDetailsOfASingleCustomAttribute: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

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


updateCustomAttributeInAccount

Update custom attribute in Account

Update a custom attribute in account


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

Usage and SDK Samples

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

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

public class CustomAttributesApiExample {

    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");

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

public class CustomAttributesApiExample {

    public static void main(String[] args) {
        CustomAttributesApi apiInstance = new CustomAttributesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer id = 56; // Integer | The ID of the custom attribute to be updated.
        Custom_attribute_create_update_payload data = ; // Custom_attribute_create_update_payload | 
        try {
            custom_attribute result = apiInstance.updateCustomAttributeInAccount(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomAttributesApi#updateCustomAttributeInAccount");
            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 custom attribute to be updated.
Custom_attribute_create_update_payload *data = ; // 

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

// Update custom attribute in Account
[apiInstance updateCustomAttributeInAccountWith:accountId
    id:id
    data:data
              completionHandler: ^(custom_attribute 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.CustomAttributesApi()

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

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

var data = ; // {Custom_attribute_create_update_payload} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCustomAttributeInAccount(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 updateCustomAttributeInAccountExample
    {
        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 CustomAttributesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 56;  // Integer | The ID of the custom attribute to be updated.
            var data = new Custom_attribute_create_update_payload(); // Custom_attribute_create_update_payload | 

            try
            {
                // Update custom attribute in Account
                custom_attribute result = apiInstance.updateCustomAttributeInAccount(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomAttributesApi.updateCustomAttributeInAccount: " + 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\CustomAttributesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 56; // Integer | The ID of the custom attribute to be updated.
$data = ; // Custom_attribute_create_update_payload | 

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

# 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::CustomAttributesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 56; # Integer | The ID of the custom attribute to be updated.
my $data = WWW::SwaggerClient::Object::Custom_attribute_create_update_payload->new(); # Custom_attribute_create_update_payload | 

eval { 
    my $result = $api_instance->updateCustomAttributeInAccount(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomAttributesApi->updateCustomAttributeInAccount: $@\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.CustomAttributesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 56 # Integer | The ID of the custom attribute to be updated.
data =  # Custom_attribute_create_update_payload | 

try: 
    # Update custom attribute in Account
    api_response = api_instance.update_custom_attribute_in_account(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomAttributesApi->updateCustomAttributeInAccount: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Agent not found


CustomFilters

createACustomFilter

Create a custom filter

Create a custom filter in the account


/api/v1/accounts/{account_id}/custom_filters

Usage and SDK Samples

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

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

public class CustomFiltersApiExample {

    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");

        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Custom_filter_create_update_payload data = ; // Custom_filter_create_update_payload | 
        String filterType = filterType_example; // String | The type of custom filter
        try {
            custom_filter result = apiInstance.createACustomFilter(accountId, data, filterType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#createACustomFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomFiltersApi;

public class CustomFiltersApiExample {

    public static void main(String[] args) {
        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Custom_filter_create_update_payload data = ; // Custom_filter_create_update_payload | 
        String filterType = filterType_example; // String | The type of custom filter
        try {
            custom_filter result = apiInstance.createACustomFilter(accountId, data, filterType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#createACustomFilter");
            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
Custom_filter_create_update_payload *data = ; // 
String *filterType = filterType_example; // The type of custom filter (optional)

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

// Create a custom filter
[apiInstance createACustomFilterWith:accountId
    data:data
    filterType:filterType
              completionHandler: ^(custom_filter 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.CustomFiltersApi()

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

var data = ; // {Custom_filter_create_update_payload} 

var opts = { 
  'filterType': filterType_example // {String} The type of custom filter
};

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

namespace Example
{
    public class createACustomFilterExample
    {
        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 CustomFiltersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Custom_filter_create_update_payload(); // Custom_filter_create_update_payload | 
            var filterType = filterType_example;  // String | The type of custom filter (optional) 

            try
            {
                // Create a custom filter
                custom_filter result = apiInstance.createACustomFilter(accountId, data, filterType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomFiltersApi.createACustomFilter: " + 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\CustomFiltersApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Custom_filter_create_update_payload | 
$filterType = filterType_example; // String | The type of custom filter

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

# 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::CustomFiltersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Custom_filter_create_update_payload->new(); # Custom_filter_create_update_payload | 
my $filterType = filterType_example; # String | The type of custom filter

eval { 
    my $result = $api_instance->createACustomFilter(accountId => $accountId, data => $data, filterType => $filterType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomFiltersApi->createACustomFilter: $@\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.CustomFiltersApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Custom_filter_create_update_payload | 
filterType = filterType_example # String | The type of custom filter (optional)

try: 
    # Create a custom filter
    api_response = api_instance.create_a_custom_filter(accountId, data, filterType=filterType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFiltersApi->createACustomFilter: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Body parameters
Name Description
data *
Query parameters
Name Description
filter_type
String
The type of custom filter

Responses

Status: 200 - Success

Status: 401 - Unauthorized


deleteACustomFilter

Delete a custom filter

Delete a custom filter from the account


/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}

Usage and SDK Samples

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

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

public class CustomFiltersApiExample {

    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");

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

public class CustomFiltersApiExample {

    public static void main(String[] args) {
        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer customFilterId = 56; // Integer | The numeric ID of the custom filter
        try {
            apiInstance.deleteACustomFilter(accountId, customFilterId);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#deleteACustomFilter");
            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 *customFilterId = 56; // The numeric ID of the custom filter

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

// Delete a custom filter
[apiInstance deleteACustomFilterWith:accountId
    customFilterId:customFilterId
              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.CustomFiltersApi()

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

var customFilterId = 56; // {Integer} The numeric ID of the custom filter


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

namespace Example
{
    public class deleteACustomFilterExample
    {
        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 CustomFiltersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var customFilterId = 56;  // Integer | The numeric ID of the custom filter

            try
            {
                // Delete a custom filter
                apiInstance.deleteACustomFilter(accountId, customFilterId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomFiltersApi.deleteACustomFilter: " + 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\CustomFiltersApi();
$accountId = 56; // Integer | The numeric ID of the account
$customFilterId = 56; // Integer | The numeric ID of the custom filter

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

# 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::CustomFiltersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $customFilterId = 56; # Integer | The numeric ID of the custom filter

eval { 
    $api_instance->deleteACustomFilter(accountId => $accountId, customFilterId => $customFilterId);
};
if ($@) {
    warn "Exception when calling CustomFiltersApi->deleteACustomFilter: $@\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.CustomFiltersApi()
accountId = 56 # Integer | The numeric ID of the account
customFilterId = 56 # Integer | The numeric ID of the custom filter

try: 
    # Delete a custom filter
    api_instance.delete_a_custom_filter(accountId, customFilterId)
except ApiException as e:
    print("Exception when calling CustomFiltersApi->deleteACustomFilter: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The custom filter does not exist in the account


getDetailsOfASingleCustomFilter

Get a custom filter details

Get the details of a custom filter in the account


/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}

Usage and SDK Samples

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

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

public class CustomFiltersApiExample {

    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");

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

public class CustomFiltersApiExample {

    public static void main(String[] args) {
        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer customFilterId = 56; // Integer | The numeric ID of the custom filter
        try {
            custom_filter result = apiInstance.getDetailsOfASingleCustomFilter(accountId, customFilterId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#getDetailsOfASingleCustomFilter");
            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 *customFilterId = 56; // The numeric ID of the custom filter

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

// Get a custom filter details
[apiInstance getDetailsOfASingleCustomFilterWith:accountId
    customFilterId:customFilterId
              completionHandler: ^(custom_filter 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.CustomFiltersApi()

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

var customFilterId = 56; // {Integer} The numeric ID of the custom filter


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

namespace Example
{
    public class getDetailsOfASingleCustomFilterExample
    {
        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 CustomFiltersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var customFilterId = 56;  // Integer | The numeric ID of the custom filter

            try
            {
                // Get a custom filter details
                custom_filter result = apiInstance.getDetailsOfASingleCustomFilter(accountId, customFilterId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomFiltersApi.getDetailsOfASingleCustomFilter: " + 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\CustomFiltersApi();
$accountId = 56; // Integer | The numeric ID of the account
$customFilterId = 56; // Integer | The numeric ID of the custom filter

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

# 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::CustomFiltersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $customFilterId = 56; # Integer | The numeric ID of the custom filter

eval { 
    my $result = $api_instance->getDetailsOfASingleCustomFilter(accountId => $accountId, customFilterId => $customFilterId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomFiltersApi->getDetailsOfASingleCustomFilter: $@\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.CustomFiltersApi()
accountId = 56 # Integer | The numeric ID of the account
customFilterId = 56 # Integer | The numeric ID of the custom filter

try: 
    # Get a custom filter details
    api_response = api_instance.get_details_of_a_single_custom_filter(accountId, customFilterId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFiltersApi->getDetailsOfASingleCustomFilter: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

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


listAllFilters

List all custom filters

List all custom filters in a category of a user


/api/v1/accounts/{account_id}/custom_filters

Usage and SDK Samples

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

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

public class CustomFiltersApiExample {

    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");

        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String filterType = filterType_example; // String | The type of custom filter
        try {
            array[custom_filter] result = apiInstance.listAllFilters(accountId, filterType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#listAllFilters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomFiltersApi;

public class CustomFiltersApiExample {

    public static void main(String[] args) {
        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String filterType = filterType_example; // String | The type of custom filter
        try {
            array[custom_filter] result = apiInstance.listAllFilters(accountId, filterType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#listAllFilters");
            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 *filterType = filterType_example; // The type of custom filter (optional)

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

// List all custom filters
[apiInstance listAllFiltersWith:accountId
    filterType:filterType
              completionHandler: ^(array[custom_filter] 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.CustomFiltersApi()

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

var opts = { 
  'filterType': filterType_example // {String} The type of custom filter
};

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

namespace Example
{
    public class listAllFiltersExample
    {
        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 CustomFiltersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var filterType = filterType_example;  // String | The type of custom filter (optional) 

            try
            {
                // List all custom filters
                array[custom_filter] result = apiInstance.listAllFilters(accountId, filterType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomFiltersApi.listAllFilters: " + 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\CustomFiltersApi();
$accountId = 56; // Integer | The numeric ID of the account
$filterType = filterType_example; // String | The type of custom filter

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

# 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::CustomFiltersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $filterType = filterType_example; # String | The type of custom filter

eval { 
    my $result = $api_instance->listAllFilters(accountId => $accountId, filterType => $filterType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomFiltersApi->listAllFilters: $@\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.CustomFiltersApi()
accountId = 56 # Integer | The numeric ID of the account
filterType = filterType_example # String | The type of custom filter (optional)

try: 
    # List all custom filters
    api_response = api_instance.list_all_filters(accountId, filterType=filterType)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFiltersApi->listAllFilters: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
filter_type
String
The type of custom filter

Responses

Status: 200 - Success

Status: 401 - Unauthorized


updateACustomFilter

Update a custom filter

Update a custom filter's attributes


/api/v1/accounts/{account_id}/custom_filters/{custom_filter_id}

Usage and SDK Samples

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

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

public class CustomFiltersApiExample {

    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");

        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer customFilterId = 56; // Integer | The numeric ID of the custom filter
        Custom_filter_create_update_payload data = ; // Custom_filter_create_update_payload | 
        try {
            custom_filter result = apiInstance.updateACustomFilter(accountId, customFilterId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#updateACustomFilter");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CustomFiltersApi;

public class CustomFiltersApiExample {

    public static void main(String[] args) {
        CustomFiltersApi apiInstance = new CustomFiltersApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer customFilterId = 56; // Integer | The numeric ID of the custom filter
        Custom_filter_create_update_payload data = ; // Custom_filter_create_update_payload | 
        try {
            custom_filter result = apiInstance.updateACustomFilter(accountId, customFilterId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomFiltersApi#updateACustomFilter");
            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 *customFilterId = 56; // The numeric ID of the custom filter
Custom_filter_create_update_payload *data = ; // 

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

// Update a custom filter
[apiInstance updateACustomFilterWith:accountId
    customFilterId:customFilterId
    data:data
              completionHandler: ^(custom_filter 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.CustomFiltersApi()

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

var customFilterId = 56; // {Integer} The numeric ID of the custom filter

var data = ; // {Custom_filter_create_update_payload} 


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

namespace Example
{
    public class updateACustomFilterExample
    {
        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 CustomFiltersApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var customFilterId = 56;  // Integer | The numeric ID of the custom filter
            var data = new Custom_filter_create_update_payload(); // Custom_filter_create_update_payload | 

            try
            {
                // Update a custom filter
                custom_filter result = apiInstance.updateACustomFilter(accountId, customFilterId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomFiltersApi.updateACustomFilter: " + 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\CustomFiltersApi();
$accountId = 56; // Integer | The numeric ID of the account
$customFilterId = 56; // Integer | The numeric ID of the custom filter
$data = ; // Custom_filter_create_update_payload | 

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

# 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::CustomFiltersApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $customFilterId = 56; # Integer | The numeric ID of the custom filter
my $data = WWW::SwaggerClient::Object::Custom_filter_create_update_payload->new(); # Custom_filter_create_update_payload | 

eval { 
    my $result = $api_instance->updateACustomFilter(accountId => $accountId, customFilterId => $customFilterId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomFiltersApi->updateACustomFilter: $@\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.CustomFiltersApi()
accountId = 56 # Integer | The numeric ID of the account
customFilterId = 56 # Integer | The numeric ID of the custom filter
data =  # Custom_filter_create_update_payload | 

try: 
    # Update a custom filter
    api_response = api_instance.update_a_custom_filter(accountId, customFilterId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomFiltersApi->updateACustomFilter: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Inboxes

addNewAgentToInbox

Add a New Agent

Add a new Agent to Inbox


/api/v1/accounts/{account_id}/inbox_members

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_13 data = ; // Data_13 | 
        try {
            array[agent] result = apiInstance.addNewAgentToInbox(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#addNewAgentToInbox");
            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_13 *data = ; // 

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

// Add a New Agent
[apiInstance addNewAgentToInboxWith:accountId
    data:data
              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.InboxesApi()

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

var data = ; // {Data_13} 


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

namespace Example
{
    public class addNewAgentToInboxExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data_13(); // Data_13 | 

            try
            {
                // Add a New Agent
                array[agent] result = apiInstance.addNewAgentToInbox(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.addNewAgentToInbox: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data_13 | 

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data_13->new(); # Data_13 | 

eval { 
    my $result = $api_instance->addNewAgentToInbox(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->addNewAgentToInbox: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data_13 | 

try: 
    # Add a New Agent
    api_response = api_instance.add_new_agent_to_inbox(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->addNewAgentToInbox: %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

Status: 404 - Inbox not found

Status: 422 - User must exist


deleteAgentInInbox

Remove an Agent from Inbox

Remove an Agent from Inbox


/api/v1/accounts/{account_id}/inbox_members/{inbox_id}

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer inboxId = 56; // Integer | The ID of the Inbox
        Data_12 data = ; // Data_12 | 
        try {
            apiInstance.deleteAgentInInbox(accountId, inboxId, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#deleteAgentInInbox");
            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 *inboxId = 56; // The ID of the Inbox
Data_12 *data = ; // 

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

// Remove an Agent from Inbox
[apiInstance deleteAgentInInboxWith:accountId
    inboxId:inboxId
    data:data
              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.InboxesApi()

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

var inboxId = 56; // {Integer} The ID of the Inbox

var data = ; // {Data_12} 


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

namespace Example
{
    public class deleteAgentInInboxExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var inboxId = 56;  // Integer | The ID of the Inbox
            var data = new Data_12(); // Data_12 | 

            try
            {
                // Remove an Agent from Inbox
                apiInstance.deleteAgentInInbox(accountId, inboxId, data);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.deleteAgentInInbox: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$inboxId = 56; // Integer | The ID of the Inbox
$data = ; // Data_12 | 

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $inboxId = 56; # Integer | The ID of the Inbox
my $data = WWW::SwaggerClient::Object::Data_12->new(); # Data_12 | 

eval { 
    $api_instance->deleteAgentInInbox(accountId => $accountId, inboxId => $inboxId, data => $data);
};
if ($@) {
    warn "Exception when calling InboxesApi->deleteAgentInInbox: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
inboxId = 56 # Integer | The ID of the Inbox
data =  # Data_12 | 

try: 
    # Remove an Agent from Inbox
    api_instance.delete_agent_in_inbox(accountId, inboxId, data)
except ApiException as e:
    print("Exception when calling InboxesApi->deleteAgentInInbox: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found

Status: 422 - User must exist


getInbox

Get an inbox

Get an inbox available in the current account


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

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the inbox
        try {
            inbox result = apiInstance.getInbox(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#getInbox");
            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 inbox

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

// Get an inbox
[apiInstance getInboxWith:accountId
    id:id
              completionHandler: ^(inbox 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.InboxesApi()

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

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


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

namespace Example
{
    public class getInboxExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the inbox

            try
            {
                // Get an inbox
                inbox result = apiInstance.getInbox(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.getInbox: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the inbox

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the inbox

eval { 
    my $result = $api_instance->getInbox(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->getInbox: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the inbox

try: 
    # Get an inbox
    api_response = api_instance.get_inbox(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->getInbox: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found


getInboxAgentBot

Show Inbox Agent Bot

See if an agent bot is associated to the Inbox


/api/v1/accounts/{account_id}/inboxes/{id}/agent_bot

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the inbox
        try {
            agent_bot result = apiInstance.getInboxAgentBot(accountId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#getInboxAgentBot");
            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 inbox

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

// Show Inbox Agent Bot
[apiInstance getInboxAgentBotWith: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.InboxesApi()

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

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


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

namespace Example
{
    public class getInboxAgentBotExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the inbox

            try
            {
                // Show Inbox Agent Bot
                agent_bot result = apiInstance.getInboxAgentBot(accountId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.getInboxAgentBot: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the inbox

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the inbox

eval { 
    my $result = $api_instance->getInboxAgentBot(accountId => $accountId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->getInboxAgentBot: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the inbox

try: 
    # Show Inbox Agent Bot
    api_response = api_instance.get_inbox_agent_bot(accountId, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->getInboxAgentBot: %s\n" % e)

Parameters

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

Responses

Status: 204 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found, Agent bot not found


getInboxMembers

List Agents in Inbox

Get Details of Agents in an Inbox


/api/v1/accounts/{account_id}/inbox_members/{inbox_id}

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer inboxId = 56; // Integer | The ID of the Inbox
        try {
            array[agent] result = apiInstance.getInboxMembers(accountId, inboxId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#getInboxMembers");
            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 *inboxId = 56; // The ID of the Inbox

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

// List Agents in Inbox
[apiInstance getInboxMembersWith:accountId
    inboxId:inboxId
              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.InboxesApi()

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

var inboxId = 56; // {Integer} The ID of the Inbox


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

namespace Example
{
    public class getInboxMembersExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var inboxId = 56;  // Integer | The ID of the Inbox

            try
            {
                // List Agents in Inbox
                array[agent] result = apiInstance.getInboxMembers(accountId, inboxId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.getInboxMembers: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$inboxId = 56; // Integer | The ID of the Inbox

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $inboxId = 56; # Integer | The ID of the Inbox

eval { 
    my $result = $api_instance->getInboxMembers(accountId => $accountId, inboxId => $inboxId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->getInboxMembers: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
inboxId = 56 # Integer | The ID of the Inbox

try: 
    # List Agents in Inbox
    api_response = api_instance.get_inbox_members(accountId, inboxId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->getInboxMembers: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found


inboxCreation

Create an inbox

You can create more than one website inbox in each account


/api/v1/accounts/{account_id}/inboxes

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_9 data = ; // Data_9 | 
        try {
            inbox result = apiInstance.inboxCreation(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#inboxCreation");
            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_9 *data = ; // 

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

// Create an inbox
[apiInstance inboxCreationWith:accountId
    data:data
              completionHandler: ^(inbox 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.InboxesApi()

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

var data = ; // {Data_9} 


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

namespace Example
{
    public class inboxCreationExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data_9(); // Data_9 | 

            try
            {
                // Create an inbox
                inbox result = apiInstance.inboxCreation(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.inboxCreation: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data_9 | 

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data_9->new(); # Data_9 | 

eval { 
    my $result = $api_instance->inboxCreation(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->inboxCreation: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data_9 | 

try: 
    # Create an inbox
    api_response = api_instance.inbox_creation(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->inboxCreation: %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

Status: 404 - Inbox not found


listAllInboxes

List all inboxes

List all inboxes available in the current account


/api/v1/accounts/{account_id}/inboxes/2

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[inbox] result = apiInstance.listAllInboxes(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#listAllInboxes");
            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

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

// List all inboxes
[apiInstance listAllInboxesWith:accountId
              completionHandler: ^(array[inbox] 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.InboxesApi()

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.listAllInboxes(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllInboxesExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all inboxes
                array[inbox] result = apiInstance.listAllInboxes(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.listAllInboxes: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->listAllInboxes(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->listAllInboxes: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all inboxes
    api_response = api_instance.list_all_inboxes(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->listAllInboxes: %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

Status: 404 - Inbox not found


updateAgentBot

Add or remove agent bot

To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null


/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the inbox
        Data_11 data = ; // Data_11 | 
        try {
            apiInstance.updateAgentBot(accountId, id, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#updateAgentBot");
            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 inbox
Data_11 *data = ; // 

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

// Add or remove agent bot
[apiInstance updateAgentBotWith:accountId
    id:id
    data:data
              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.InboxesApi()

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

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

var data = ; // {Data_11} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.updateAgentBot(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 updateAgentBotExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the inbox
            var data = new Data_11(); // Data_11 | 

            try
            {
                // Add or remove agent bot
                apiInstance.updateAgentBot(accountId, id, data);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.updateAgentBot: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the inbox
$data = ; // Data_11 | 

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the inbox
my $data = WWW::SwaggerClient::Object::Data_11->new(); # Data_11 | 

eval { 
    $api_instance->updateAgentBot(accountId => $accountId, id => $id, data => $data);
};
if ($@) {
    warn "Exception when calling InboxesApi->updateAgentBot: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the inbox
data =  # Data_11 | 

try: 
    # Add or remove agent bot
    api_instance.update_agent_bot(accountId, id, data)
except ApiException as e:
    print("Exception when calling InboxesApi->updateAgentBot: %s\n" % e)

Parameters

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

Responses

Status: 204 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found, Agent bot not found


updateAgentsInInbox

Update Agents in Inbox

All agents except the one passed in params will be removed


/api/v1/accounts/{account_id}/inbox_members

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Data_14 data = ; // Data_14 | 
        try {
            array[agent] result = apiInstance.updateAgentsInInbox(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#updateAgentsInInbox");
            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_14 *data = ; // 

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

// Update Agents in Inbox
[apiInstance updateAgentsInInboxWith:accountId
    data:data
              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.InboxesApi()

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

var data = ; // {Data_14} 


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

namespace Example
{
    public class updateAgentsInInboxExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Data_14(); // Data_14 | 

            try
            {
                // Update Agents in Inbox
                array[agent] result = apiInstance.updateAgentsInInbox(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.updateAgentsInInbox: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Data_14 | 

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Data_14->new(); # Data_14 | 

eval { 
    my $result = $api_instance->updateAgentsInInbox(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->updateAgentsInInbox: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Data_14 | 

try: 
    # Update Agents in Inbox
    api_response = api_instance.update_agents_in_inbox(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->updateAgentsInInbox: %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

Status: 404 - Inbox not found

Status: 422 - User must exist


updateInbox

Update Inbox

Add avatar and disable auto assignment for an inbox


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

Usage and SDK Samples

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

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

public class InboxesApiExample {

    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");

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

public class InboxesApiExample {

    public static void main(String[] args) {
        InboxesApi apiInstance = new InboxesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        BigDecimal id = 8.14; // BigDecimal | ID of the inbox
        Data_10 data = ; // Data_10 | 
        try {
            inbox result = apiInstance.updateInbox(accountId, id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InboxesApi#updateInbox");
            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 inbox
Data_10 *data = ; // 

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

// Update Inbox
[apiInstance updateInboxWith:accountId
    id:id
    data:data
              completionHandler: ^(inbox 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.InboxesApi()

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

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

var data = ; // {Data_10} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateInbox(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 updateInboxExample
    {
        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 InboxesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var id = 8.14;  // BigDecimal | ID of the inbox
            var data = new Data_10(); // Data_10 | 

            try
            {
                // Update Inbox
                inbox result = apiInstance.updateInbox(accountId, id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InboxesApi.updateInbox: " + 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\InboxesApi();
$accountId = 56; // Integer | The numeric ID of the account
$id = 8.14; // BigDecimal | ID of the inbox
$data = ; // Data_10 | 

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

# 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::InboxesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $id = 8.14; # BigDecimal | ID of the inbox
my $data = WWW::SwaggerClient::Object::Data_10->new(); # Data_10 | 

eval { 
    my $result = $api_instance->updateInbox(accountId => $accountId, id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InboxesApi->updateInbox: $@\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.InboxesApi()
accountId = 56 # Integer | The numeric ID of the account
id = 8.14 # BigDecimal | ID of the inbox
data =  # Data_10 | 

try: 
    # Update Inbox
    api_response = api_instance.update_inbox(accountId, id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InboxesApi->updateInbox: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found


Integrations

createAnIntegrationHook

Create an integration hook

Create an integration hook


/api/v1/accounts/{account_id}/integrations/hooks

Usage and SDK Samples

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

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

public class IntegrationsApiExample {

    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");

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

public class IntegrationsApiExample {

    public static void main(String[] args) {
        IntegrationsApi apiInstance = new IntegrationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integrations_hook_create_payload data = ; // Integrations_hook_create_payload | 
        try {
            integrations_hook result = apiInstance.createAnIntegrationHook(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationsApi#createAnIntegrationHook");
            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
Integrations_hook_create_payload *data = ; // 

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

// Create an integration hook
[apiInstance createAnIntegrationHookWith:accountId
    data:data
              completionHandler: ^(integrations_hook 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.IntegrationsApi()

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

var data = ; // {Integrations_hook_create_payload} 


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

namespace Example
{
    public class createAnIntegrationHookExample
    {
        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 IntegrationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Integrations_hook_create_payload(); // Integrations_hook_create_payload | 

            try
            {
                // Create an integration hook
                integrations_hook result = apiInstance.createAnIntegrationHook(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationsApi.createAnIntegrationHook: " + 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\IntegrationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Integrations_hook_create_payload | 

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

# 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::IntegrationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Integrations_hook_create_payload->new(); # Integrations_hook_create_payload | 

eval { 
    my $result = $api_instance->createAnIntegrationHook(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationsApi->createAnIntegrationHook: $@\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.IntegrationsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Integrations_hook_create_payload | 

try: 
    # Create an integration hook
    api_response = api_instance.create_an_integration_hook(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsApi->createAnIntegrationHook: %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


deleteAnIntegrationHook

Delete an Integration Hook

Delete an Integration Hook


/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}

Usage and SDK Samples

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

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

public class IntegrationsApiExample {

    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");

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

public class IntegrationsApiExample {

    public static void main(String[] args) {
        IntegrationsApi apiInstance = new IntegrationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer hookId = 56; // Integer | The numeric ID of the integration hook
        try {
            apiInstance.deleteAnIntegrationHook(accountId, hookId);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationsApi#deleteAnIntegrationHook");
            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 *hookId = 56; // The numeric ID of the integration hook

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

// Delete an Integration Hook
[apiInstance deleteAnIntegrationHookWith:accountId
    hookId:hookId
              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.IntegrationsApi()

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

var hookId = 56; // {Integer} The numeric ID of the integration hook


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

namespace Example
{
    public class deleteAnIntegrationHookExample
    {
        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 IntegrationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var hookId = 56;  // Integer | The numeric ID of the integration hook

            try
            {
                // Delete an Integration Hook
                apiInstance.deleteAnIntegrationHook(accountId, hookId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationsApi.deleteAnIntegrationHook: " + 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\IntegrationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$hookId = 56; // Integer | The numeric ID of the integration hook

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

# 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::IntegrationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $hookId = 56; # Integer | The numeric ID of the integration hook

eval { 
    $api_instance->deleteAnIntegrationHook(accountId => $accountId, hookId => $hookId);
};
if ($@) {
    warn "Exception when calling IntegrationsApi->deleteAnIntegrationHook: $@\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.IntegrationsApi()
accountId = 56 # Integer | The numeric ID of the account
hookId = 56 # Integer | The numeric ID of the integration hook

try: 
    # Delete an Integration Hook
    api_instance.delete_an_integration_hook(accountId, hookId)
except ApiException as e:
    print("Exception when calling IntegrationsApi->deleteAnIntegrationHook: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The hook does not exist in the account


getDetailsOfAllIntegrations

List all the Integrations

Get the details of all Integrations available for the account


/api/v1/accounts/{account_id}/integrations/apps

Usage and SDK Samples

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

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

public class IntegrationsApiExample {

    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");

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

public class IntegrationsApiExample {

    public static void main(String[] args) {
        IntegrationsApi apiInstance = new IntegrationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[integrations_app] result = apiInstance.getDetailsOfAllIntegrations(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationsApi#getDetailsOfAllIntegrations");
            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

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

// List all the Integrations
[apiInstance getDetailsOfAllIntegrationsWith:accountId
              completionHandler: ^(array[integrations_app] 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.IntegrationsApi()

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.getDetailsOfAllIntegrations(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDetailsOfAllIntegrationsExample
    {
        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 IntegrationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all the Integrations
                array[integrations_app] result = apiInstance.getDetailsOfAllIntegrations(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationsApi.getDetailsOfAllIntegrations: " + 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\IntegrationsApi();
$accountId = 56; // Integer | The numeric ID of the account

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

# 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::IntegrationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->getDetailsOfAllIntegrations(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationsApi->getDetailsOfAllIntegrations: $@\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.IntegrationsApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all the Integrations
    api_response = api_instance.get_details_of_all_integrations(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsApi->getDetailsOfAllIntegrations: %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 - Url not found


updateAnIntegrationsHook

Update an Integration Hook

Update an Integration Hook


/api/v1/accounts/{account_id}/integrations/hooks/{hook_id}

Usage and SDK Samples

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

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

public class IntegrationsApiExample {

    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");

        IntegrationsApi apiInstance = new IntegrationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer hookId = 56; // Integer | The numeric ID of the integration hook
        Integrations_hook_update_payload data = ; // Integrations_hook_update_payload | 
        try {
            integrations_hook result = apiInstance.updateAnIntegrationsHook(accountId, hookId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationsApi#updateAnIntegrationsHook");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.IntegrationsApi;

public class IntegrationsApiExample {

    public static void main(String[] args) {
        IntegrationsApi apiInstance = new IntegrationsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer hookId = 56; // Integer | The numeric ID of the integration hook
        Integrations_hook_update_payload data = ; // Integrations_hook_update_payload | 
        try {
            integrations_hook result = apiInstance.updateAnIntegrationsHook(accountId, hookId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationsApi#updateAnIntegrationsHook");
            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 *hookId = 56; // The numeric ID of the integration hook
Integrations_hook_update_payload *data = ; // 

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

// Update an Integration Hook
[apiInstance updateAnIntegrationsHookWith:accountId
    hookId:hookId
    data:data
              completionHandler: ^(integrations_hook 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.IntegrationsApi()

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

var hookId = 56; // {Integer} The numeric ID of the integration hook

var data = ; // {Integrations_hook_update_payload} 


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

namespace Example
{
    public class updateAnIntegrationsHookExample
    {
        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 IntegrationsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var hookId = 56;  // Integer | The numeric ID of the integration hook
            var data = new Integrations_hook_update_payload(); // Integrations_hook_update_payload | 

            try
            {
                // Update an Integration Hook
                integrations_hook result = apiInstance.updateAnIntegrationsHook(accountId, hookId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationsApi.updateAnIntegrationsHook: " + 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\IntegrationsApi();
$accountId = 56; // Integer | The numeric ID of the account
$hookId = 56; // Integer | The numeric ID of the integration hook
$data = ; // Integrations_hook_update_payload | 

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

# 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::IntegrationsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $hookId = 56; # Integer | The numeric ID of the integration hook
my $data = WWW::SwaggerClient::Object::Integrations_hook_update_payload->new(); # Integrations_hook_update_payload | 

eval { 
    my $result = $api_instance->updateAnIntegrationsHook(accountId => $accountId, hookId => $hookId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling IntegrationsApi->updateAnIntegrationsHook: $@\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.IntegrationsApi()
accountId = 56 # Integer | The numeric ID of the account
hookId = 56 # Integer | The numeric ID of the integration hook
data =  # Integrations_hook_update_payload | 

try: 
    # Update an Integration Hook
    api_response = api_instance.update_an_integrations_hook(accountId, hookId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationsApi->updateAnIntegrationsHook: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Messages

createANewMessageInAConversation

Create New Message

Create a new message in the conversation


/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages

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}/conversations/{conversation_id}/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MessagesApi;

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

public class MessagesApiExample {

    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");

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

public class MessagesApiExample {

    public static void main(String[] args) {
        MessagesApi apiInstance = new MessagesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Conversation_message_create data = ; // Conversation_message_create | 
        try {
            inline_response_200_5 result = apiInstance.createANewMessageInAConversation(accountId, conversationId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#createANewMessageInAConversation");
            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
Integer *conversationId = 56; // The numeric ID of the conversation
Conversation_message_create *data = ; // 

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

// Create New Message
[apiInstance createANewMessageInAConversationWith:accountId
    conversationId:conversationId
    data:data
              completionHandler: ^(inline_response_200_5 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.MessagesApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation

var data = ; // {Conversation_message_create} 


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

namespace Example
{
    public class createANewMessageInAConversationExample
    {
        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 MessagesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation
            var data = new Conversation_message_create(); // Conversation_message_create | 

            try
            {
                // Create New Message
                inline_response_200_5 result = apiInstance.createANewMessageInAConversation(accountId, conversationId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesApi.createANewMessageInAConversation: " + 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\MessagesApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation
$data = ; // Conversation_message_create | 

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

# 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::MessagesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $data = WWW::SwaggerClient::Object::Conversation_message_create->new(); # Conversation_message_create | 

eval { 
    my $result = $api_instance->createANewMessageInAConversation(accountId => $accountId, conversationId => $conversationId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesApi->createANewMessageInAConversation: $@\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.MessagesApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation
data =  # Conversation_message_create | 

try: 
    # Create New Message
    api_response = api_instance.create_a_new_message_in_a_conversation(accountId, conversationId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesApi->createANewMessageInAConversation: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Conversation not found


deleteAMessage

Delete a message

Delete a message and it's attachments from the conversation.


/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/{message_id}

Usage and SDK Samples

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

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

public class MessagesApiExample {

    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");

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

public class MessagesApiExample {

    public static void main(String[] args) {
        MessagesApi apiInstance = new MessagesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Integer messageId = 56; // Integer | The numeric ID of the message
        try {
            apiInstance.deleteAMessage(accountId, conversationId, messageId);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#deleteAMessage");
            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 *conversationId = 56; // The numeric ID of the conversation
Integer *messageId = 56; // The numeric ID of the message

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

// Delete a message
[apiInstance deleteAMessageWith:accountId
    conversationId:conversationId
    messageId:messageId
              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.MessagesApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation

var messageId = 56; // {Integer} The numeric ID of the message


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

namespace Example
{
    public class deleteAMessageExample
    {
        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 MessagesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation
            var messageId = 56;  // Integer | The numeric ID of the message

            try
            {
                // Delete a message
                apiInstance.deleteAMessage(accountId, conversationId, messageId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesApi.deleteAMessage: " + 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\MessagesApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation
$messageId = 56; // Integer | The numeric ID of the message

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

# 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::MessagesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $messageId = 56; # Integer | The numeric ID of the message

eval { 
    $api_instance->deleteAMessage(accountId => $accountId, conversationId => $conversationId, messageId => $messageId);
};
if ($@) {
    warn "Exception when calling MessagesApi->deleteAMessage: $@\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.MessagesApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation
messageId = 56 # Integer | The numeric ID of the message

try: 
    # Delete a message
    api_instance.delete_a_message(accountId, conversationId, messageId)
except ApiException as e:
    print("Exception when calling MessagesApi->deleteAMessage: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
conversation_id*
Integer
The numeric ID of the conversation
Required
message_id*
Integer
The numeric ID of the message
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The message or conversation does not exist in the account


listAllMessages

Get messages

List all messages of a conversation


/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages

Usage and SDK Samples

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

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

public class MessagesApiExample {

    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");

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

public class MessagesApiExample {

    public static void main(String[] args) {
        MessagesApi apiInstance = new MessagesApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        try {
            array[Object] result = apiInstance.listAllMessages(accountId, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesApi#listAllMessages");
            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 *conversationId = 56; // The numeric ID of the conversation

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

// Get messages
[apiInstance listAllMessagesWith:accountId
    conversationId:conversationId
              completionHandler: ^(array[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: 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.MessagesApi()

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

var conversationId = 56; // {Integer} The numeric ID of the conversation


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

namespace Example
{
    public class listAllMessagesExample
    {
        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 MessagesApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var conversationId = 56;  // Integer | The numeric ID of the conversation

            try
            {
                // Get messages
                array[Object] result = apiInstance.listAllMessages(accountId, conversationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesApi.listAllMessages: " + 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\MessagesApi();
$accountId = 56; // Integer | The numeric ID of the account
$conversationId = 56; // Integer | The numeric ID of the conversation

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

# 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::MessagesApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $conversationId = 56; # Integer | The numeric ID of the conversation

eval { 
    my $result = $api_instance->listAllMessages(accountId => $accountId, conversationId => $conversationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesApi->listAllMessages: $@\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.MessagesApi()
accountId = 56 # Integer | The numeric ID of the account
conversationId = 56 # Integer | The numeric ID of the conversation

try: 
    # Get messages
    api_response = api_instance.list_all_messages(accountId, conversationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesApi->listAllMessages: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - Conversation not found


MessagesAPI

createAMessage

Create a message

Create a message


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages

Usage and SDK Samples

curl -X POST "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MessagesAPIApi;

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

public class MessagesAPIApiExample {

    public static void main(String[] args) {
        
        MessagesAPIApi apiInstance = new MessagesAPIApi();
        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
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Public_message_create_payload data = ; // Public_message_create_payload | 
        try {
            public_message result = apiInstance.createAMessage(inboxIdentifier, contactIdentifier, conversationId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesAPIApi#createAMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MessagesAPIApi;

public class MessagesAPIApiExample {

    public static void main(String[] args) {
        MessagesAPIApi apiInstance = new MessagesAPIApi();
        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
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Public_message_create_payload data = ; // Public_message_create_payload | 
        try {
            public_message result = apiInstance.createAMessage(inboxIdentifier, contactIdentifier, conversationId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesAPIApi#createAMessage");
            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
Integer *conversationId = 56; // The numeric ID of the conversation
Public_message_create_payload *data = ; // 

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

// Create a message
[apiInstance createAMessageWith:inboxIdentifier
    contactIdentifier:contactIdentifier
    conversationId:conversationId
    data:data
              completionHandler: ^(public_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');

var api = new Ooctopus.MessagesAPIApi()

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 conversationId = 56; // {Integer} The numeric ID of the conversation

var data = ; // {Public_message_create_payload} 


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

namespace Example
{
    public class createAMessageExample
    {
        public void main()
        {
            
            var apiInstance = new MessagesAPIApi();
            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 conversationId = 56;  // Integer | The numeric ID of the conversation
            var data = new Public_message_create_payload(); // Public_message_create_payload | 

            try
            {
                // Create a message
                public_message result = apiInstance.createAMessage(inboxIdentifier, contactIdentifier, conversationId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesAPIApi.createAMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MessagesAPIApi();
$inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
$contactIdentifier = contactIdentifier_example; // String | The source id of contact obtained on contact create
$conversationId = 56; // Integer | The numeric ID of the conversation
$data = ; // Public_message_create_payload | 

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

my $api_instance = WWW::SwaggerClient::MessagesAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $contactIdentifier = contactIdentifier_example; # String | The source id of contact obtained on contact create
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $data = WWW::SwaggerClient::Object::Public_message_create_payload->new(); # Public_message_create_payload | 

eval { 
    my $result = $api_instance->createAMessage(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier, conversationId => $conversationId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesAPIApi->createAMessage: $@\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.MessagesAPIApi()
inboxIdentifier = inboxIdentifier_example # String | The identifier obtained from API inbox channel
contactIdentifier = contactIdentifier_example # String | The source id of contact obtained on contact create
conversationId = 56 # Integer | The numeric ID of the conversation
data =  # Public_message_create_payload | 

try: 
    # Create a message
    api_response = api_instance.create_a_message(inboxIdentifier, contactIdentifier, conversationId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesAPIApi->createAMessage: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required
conversation_id*
Integer
The numeric ID of the conversation
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


listAllConverationMessages

List all messages

List all messages in the conversation


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MessagesAPIApi;

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

public class MessagesAPIApiExample {

    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");

        MessagesAPIApi apiInstance = new MessagesAPIApi();
        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
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        try {
            array[public_message] result = apiInstance.listAllConverationMessages(inboxIdentifier, contactIdentifier, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesAPIApi#listAllConverationMessages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MessagesAPIApi;

public class MessagesAPIApiExample {

    public static void main(String[] args) {
        MessagesAPIApi apiInstance = new MessagesAPIApi();
        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
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        try {
            array[public_message] result = apiInstance.listAllConverationMessages(inboxIdentifier, contactIdentifier, conversationId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesAPIApi#listAllConverationMessages");
            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"];

String *inboxIdentifier = inboxIdentifier_example; // The identifier obtained from API inbox channel
String *contactIdentifier = contactIdentifier_example; // The source id of contact obtained on contact create
Integer *conversationId = 56; // The numeric ID of the conversation

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

// List all messages
[apiInstance listAllConverationMessagesWith:inboxIdentifier
    contactIdentifier:contactIdentifier
    conversationId:conversationId
              completionHandler: ^(array[public_message] 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.MessagesAPIApi()

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 conversationId = 56; // {Integer} The numeric ID of the conversation


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

namespace Example
{
    public class listAllConverationMessagesExample
    {
        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 MessagesAPIApi();
            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 conversationId = 56;  // Integer | The numeric ID of the conversation

            try
            {
                // List all messages
                array[public_message] result = apiInstance.listAllConverationMessages(inboxIdentifier, contactIdentifier, conversationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesAPIApi.listAllConverationMessages: " + 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\MessagesAPIApi();
$inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
$contactIdentifier = contactIdentifier_example; // String | The source id of contact obtained on contact create
$conversationId = 56; // Integer | The numeric ID of the conversation

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

# 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::MessagesAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $contactIdentifier = contactIdentifier_example; # String | The source id of contact obtained on contact create
my $conversationId = 56; # Integer | The numeric ID of the conversation

eval { 
    my $result = $api_instance->listAllConverationMessages(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier, conversationId => $conversationId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesAPIApi->listAllConverationMessages: $@\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.MessagesAPIApi()
inboxIdentifier = inboxIdentifier_example # String | The identifier obtained from API inbox channel
contactIdentifier = contactIdentifier_example # String | The source id of contact obtained on contact create
conversationId = 56 # Integer | The numeric ID of the conversation

try: 
    # List all messages
    api_response = api_instance.list_all_converation_messages(inboxIdentifier, contactIdentifier, conversationId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesAPIApi->listAllConverationMessages: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required
conversation_id*
Integer
The numeric ID of the conversation
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized


updateAMessage

Update a message

Update a message


/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}

Usage and SDK Samples

curl -X PATCH "https://app.ooctopus.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations/{conversation_id}/messages/{message_id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MessagesAPIApi;

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

public class MessagesAPIApiExample {

    public static void main(String[] args) {
        
        MessagesAPIApi apiInstance = new MessagesAPIApi();
        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
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Integer messageId = 56; // Integer | The numeric ID of the message
        Public_message_update_payload data = ; // Public_message_update_payload | 
        try {
            public_message result = apiInstance.updateAMessage(inboxIdentifier, contactIdentifier, conversationId, messageId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesAPIApi#updateAMessage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MessagesAPIApi;

public class MessagesAPIApiExample {

    public static void main(String[] args) {
        MessagesAPIApi apiInstance = new MessagesAPIApi();
        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
        Integer conversationId = 56; // Integer | The numeric ID of the conversation
        Integer messageId = 56; // Integer | The numeric ID of the message
        Public_message_update_payload data = ; // Public_message_update_payload | 
        try {
            public_message result = apiInstance.updateAMessage(inboxIdentifier, contactIdentifier, conversationId, messageId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MessagesAPIApi#updateAMessage");
            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
Integer *conversationId = 56; // The numeric ID of the conversation
Integer *messageId = 56; // The numeric ID of the message
Public_message_update_payload *data = ; // 

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

// Update a message
[apiInstance updateAMessageWith:inboxIdentifier
    contactIdentifier:contactIdentifier
    conversationId:conversationId
    messageId:messageId
    data:data
              completionHandler: ^(public_message output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Ooctopus = require('ooctopus');

var api = new Ooctopus.MessagesAPIApi()

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 conversationId = 56; // {Integer} The numeric ID of the conversation

var messageId = 56; // {Integer} The numeric ID of the message

var data = ; // {Public_message_update_payload} 


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

namespace Example
{
    public class updateAMessageExample
    {
        public void main()
        {
            
            var apiInstance = new MessagesAPIApi();
            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 conversationId = 56;  // Integer | The numeric ID of the conversation
            var messageId = 56;  // Integer | The numeric ID of the message
            var data = new Public_message_update_payload(); // Public_message_update_payload | 

            try
            {
                // Update a message
                public_message result = apiInstance.updateAMessage(inboxIdentifier, contactIdentifier, conversationId, messageId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MessagesAPIApi.updateAMessage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\MessagesAPIApi();
$inboxIdentifier = inboxIdentifier_example; // String | The identifier obtained from API inbox channel
$contactIdentifier = contactIdentifier_example; // String | The source id of contact obtained on contact create
$conversationId = 56; // Integer | The numeric ID of the conversation
$messageId = 56; // Integer | The numeric ID of the message
$data = ; // Public_message_update_payload | 

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

my $api_instance = WWW::SwaggerClient::MessagesAPIApi->new();
my $inboxIdentifier = inboxIdentifier_example; # String | The identifier obtained from API inbox channel
my $contactIdentifier = contactIdentifier_example; # String | The source id of contact obtained on contact create
my $conversationId = 56; # Integer | The numeric ID of the conversation
my $messageId = 56; # Integer | The numeric ID of the message
my $data = WWW::SwaggerClient::Object::Public_message_update_payload->new(); # Public_message_update_payload | 

eval { 
    my $result = $api_instance->updateAMessage(inboxIdentifier => $inboxIdentifier, contactIdentifier => $contactIdentifier, conversationId => $conversationId, messageId => $messageId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MessagesAPIApi->updateAMessage: $@\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.MessagesAPIApi()
inboxIdentifier = inboxIdentifier_example # String | The identifier obtained from API inbox channel
contactIdentifier = contactIdentifier_example # String | The source id of contact obtained on contact create
conversationId = 56 # Integer | The numeric ID of the conversation
messageId = 56 # Integer | The numeric ID of the message
data =  # Public_message_update_payload | 

try: 
    # Update a message
    api_response = api_instance.update_a_message(inboxIdentifier, contactIdentifier, conversationId, messageId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MessagesAPIApi->updateAMessage: %s\n" % e)

Parameters

Path parameters
Name Description
inbox_identifier*
String
The identifier obtained from API inbox channel
Required
contact_identifier*
String
The source id of contact obtained on contact create
Required
conversation_id*
Integer
The numeric ID of the conversation
Required
message_id*
Integer
The numeric ID of the message
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Profile

fetchProfile

Fetch user profile

Get the user profile details


/profile

Usage and SDK Samples

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

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

public class ProfileApiExample {

    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");

        ProfileApi apiInstance = new ProfileApi();
        try {
            user result = apiInstance.fetchProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#fetchProfile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProfileApi;

public class ProfileApiExample {

    public static void main(String[] args) {
        ProfileApi apiInstance = new ProfileApi();
        try {
            user result = apiInstance.fetchProfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProfileApi#fetchProfile");
            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"];


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

// Fetch user profile
[apiInstance fetchProfileWithCompletionHandler: 
              ^(user 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.ProfileApi()

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

namespace Example
{
    public class fetchProfileExample
    {
        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 ProfileApi();

            try
            {
                // Fetch user profile
                user result = apiInstance.fetchProfile();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProfileApi.fetchProfile: " + 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\ProfileApi();

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

# 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::ProfileApi->new();

eval { 
    my $result = $api_instance->fetchProfile();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProfileApi->fetchProfile: $@\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.ProfileApi()

try: 
    # Fetch user profile
    api_response = api_instance.fetch_profile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProfileApi->fetchProfile: %s\n" % e)

Parameters

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Reports

getAccountConversationMetrics

Account Conversation Metrics

Get conversation metrics for Account


/api/v2/accounts/{account_id}/reports/conversations

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v2/accounts/{account_id}/reports/conversations?type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    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");

        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String type = type_example; // String | Type of report
        try {
            inline_response_200_7 result = apiInstance.getAccountConversationMetrics(accountId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getAccountConversationMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String type = type_example; // String | Type of report
        try {
            inline_response_200_7 result = apiInstance.getAccountConversationMetrics(accountId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getAccountConversationMetrics");
            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 *type = type_example; // Type of report

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

// Account Conversation Metrics
[apiInstance getAccountConversationMetricsWith:accountId
    type:type
              completionHandler: ^(inline_response_200_7 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.ReportsApi()

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

var type = type_example; // {String} Type of report


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

namespace Example
{
    public class getAccountConversationMetricsExample
    {
        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 ReportsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var type = type_example;  // String | Type of report

            try
            {
                // Account Conversation Metrics
                inline_response_200_7 result = apiInstance.getAccountConversationMetrics(accountId, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getAccountConversationMetrics: " + 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\ReportsApi();
$accountId = 56; // Integer | The numeric ID of the account
$type = type_example; // String | Type of report

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

# 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::ReportsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $type = type_example; # String | Type of report

eval { 
    my $result = $api_instance->getAccountConversationMetrics(accountId => $accountId, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getAccountConversationMetrics: $@\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.ReportsApi()
accountId = 56 # Integer | The numeric ID of the account
type = type_example # String | Type of report

try: 
    # Account Conversation Metrics
    api_response = api_instance.get_account_conversation_metrics(accountId, type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getAccountConversationMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
type*
String
Type of report
Required

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - reports not found


getAgentConversationMetrics

Agent Conversation Metrics

Get conversation metrics for Agent


/api/v2/accounts/{account_id}/reports/conversations/

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v2/accounts/{account_id}/reports/conversations/?type=&user_id="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    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");

        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String type = type_example; // String | Type of report
        String userId = userId_example; // String | The numeric ID of the user
        try {
            array[agent_conversation_metrics] result = apiInstance.getAgentConversationMetrics(accountId, type, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getAgentConversationMetrics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String type = type_example; // String | Type of report
        String userId = userId_example; // String | The numeric ID of the user
        try {
            array[agent_conversation_metrics] result = apiInstance.getAgentConversationMetrics(accountId, type, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#getAgentConversationMetrics");
            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 *type = type_example; // Type of report
String *userId = userId_example; // The numeric ID of the user (optional)

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

// Agent Conversation Metrics
[apiInstance getAgentConversationMetricsWith:accountId
    type:type
    userId:userId
              completionHandler: ^(array[agent_conversation_metrics] 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.ReportsApi()

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

var type = type_example; // {String} Type of report

var opts = { 
  'userId': userId_example // {String} The numeric ID of the user
};

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

namespace Example
{
    public class getAgentConversationMetricsExample
    {
        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 ReportsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var type = type_example;  // String | Type of report
            var userId = userId_example;  // String | The numeric ID of the user (optional) 

            try
            {
                // Agent Conversation Metrics
                array[agent_conversation_metrics] result = apiInstance.getAgentConversationMetrics(accountId, type, userId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.getAgentConversationMetrics: " + 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\ReportsApi();
$accountId = 56; // Integer | The numeric ID of the account
$type = type_example; // String | Type of report
$userId = userId_example; // String | The numeric ID of the user

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

# 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::ReportsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $type = type_example; # String | Type of report
my $userId = userId_example; # String | The numeric ID of the user

eval { 
    my $result = $api_instance->getAgentConversationMetrics(accountId => $accountId, type => $type, userId => $userId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->getAgentConversationMetrics: $@\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.ReportsApi()
accountId = 56 # Integer | The numeric ID of the account
type = type_example # String | Type of report
userId = userId_example # String | The numeric ID of the user (optional)

try: 
    # Agent Conversation Metrics
    api_response = api_instance.get_agent_conversation_metrics(accountId, type, userId=userId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->getAgentConversationMetrics: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
type*
String
Type of report
Required
user_id
String
The numeric ID of the user

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - reports not found


listAllConversationStatistics

Get Account reports

Get Account reports for a specific type, metric and date range


/api/v2/accounts/{account_id}/reports

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v2/accounts/{account_id}/reports?metric=&type=&id=&since=&until="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    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");

        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String metric = metric_example; // String | The type of metric
        String type = type_example; // String | Type of report
        String id = id_example; // String | The Id of specific object in case of agent/inbox/label
        String since = since_example; // String | The timestamp from where report should start.
        String until = until_example; // String | The timestamp from where report should stop.
        try {
            array[inline_response_200_6] result = apiInstance.listAllConversationStatistics(accountId, metric, type, id, since, until);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#listAllConversationStatistics");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String metric = metric_example; // String | The type of metric
        String type = type_example; // String | Type of report
        String id = id_example; // String | The Id of specific object in case of agent/inbox/label
        String since = since_example; // String | The timestamp from where report should start.
        String until = until_example; // String | The timestamp from where report should stop.
        try {
            array[inline_response_200_6] result = apiInstance.listAllConversationStatistics(accountId, metric, type, id, since, until);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#listAllConversationStatistics");
            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 *metric = metric_example; // The type of metric
String *type = type_example; // Type of report
String *id = id_example; // The Id of specific object in case of agent/inbox/label (optional)
String *since = since_example; // The timestamp from where report should start. (optional)
String *until = until_example; // The timestamp from where report should stop. (optional)

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

// Get Account reports
[apiInstance listAllConversationStatisticsWith:accountId
    metric:metric
    type:type
    id:id
    since:since
    until:until
              completionHandler: ^(array[inline_response_200_6] 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.ReportsApi()

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

var metric = metric_example; // {String} The type of metric

var type = type_example; // {String} Type of report

var opts = { 
  'id': id_example, // {String} The Id of specific object in case of agent/inbox/label
  'since': since_example, // {String} The timestamp from where report should start.
  'until': until_example // {String} The timestamp from where report should stop.
};

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

namespace Example
{
    public class listAllConversationStatisticsExample
    {
        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 ReportsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var metric = metric_example;  // String | The type of metric
            var type = type_example;  // String | Type of report
            var id = id_example;  // String | The Id of specific object in case of agent/inbox/label (optional) 
            var since = since_example;  // String | The timestamp from where report should start. (optional) 
            var until = until_example;  // String | The timestamp from where report should stop. (optional) 

            try
            {
                // Get Account reports
                array[inline_response_200_6] result = apiInstance.listAllConversationStatistics(accountId, metric, type, id, since, until);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.listAllConversationStatistics: " + 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\ReportsApi();
$accountId = 56; // Integer | The numeric ID of the account
$metric = metric_example; // String | The type of metric
$type = type_example; // String | Type of report
$id = id_example; // String | The Id of specific object in case of agent/inbox/label
$since = since_example; // String | The timestamp from where report should start.
$until = until_example; // String | The timestamp from where report should stop.

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

# 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::ReportsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $metric = metric_example; # String | The type of metric
my $type = type_example; # String | Type of report
my $id = id_example; # String | The Id of specific object in case of agent/inbox/label
my $since = since_example; # String | The timestamp from where report should start.
my $until = until_example; # String | The timestamp from where report should stop.

eval { 
    my $result = $api_instance->listAllConversationStatistics(accountId => $accountId, metric => $metric, type => $type, id => $id, since => $since, until => $until);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->listAllConversationStatistics: $@\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.ReportsApi()
accountId = 56 # Integer | The numeric ID of the account
metric = metric_example # String | The type of metric
type = type_example # String | Type of report
id = id_example # String | The Id of specific object in case of agent/inbox/label (optional)
since = since_example # String | The timestamp from where report should start. (optional)
until = until_example # String | The timestamp from where report should stop. (optional)

try: 
    # Get Account reports
    api_response = api_instance.list_all_conversation_statistics(accountId, metric, type, id=id, since=since, until=until)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->listAllConversationStatistics: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
metric*
String
The type of metric
Required
type*
String
Type of report
Required
id
String
The Id of specific object in case of agent/inbox/label
since
String
The timestamp from where report should start.
until
String
The timestamp from where report should stop.

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - reports not found


listAllConversationStatisticsSummary

Get Account reports summary

Get Account reports summary for a specific type and date range


/api/v2/accounts/{account_id}/reports/summary

Usage and SDK Samples

curl -X GET -H "api_access_token: [[apiKey]]" "https://app.ooctopus.com/api/v2/accounts/{account_id}/reports/summary?type=&id=&since=&until="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportsApi;

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

public class ReportsApiExample {

    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");

        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String type = type_example; // String | Type of report
        String id = id_example; // String | The Id of specific object in case of agent/inbox/label
        String since = since_example; // String | The timestamp from where report should start.
        String until = until_example; // String | The timestamp from where report should stop.
        try {
            account_summary result = apiInstance.listAllConversationStatisticsSummary(accountId, type, id, since, until);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#listAllConversationStatisticsSummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ReportsApi;

public class ReportsApiExample {

    public static void main(String[] args) {
        ReportsApi apiInstance = new ReportsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        String type = type_example; // String | Type of report
        String id = id_example; // String | The Id of specific object in case of agent/inbox/label
        String since = since_example; // String | The timestamp from where report should start.
        String until = until_example; // String | The timestamp from where report should stop.
        try {
            account_summary result = apiInstance.listAllConversationStatisticsSummary(accountId, type, id, since, until);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportsApi#listAllConversationStatisticsSummary");
            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 *type = type_example; // Type of report
String *id = id_example; // The Id of specific object in case of agent/inbox/label (optional)
String *since = since_example; // The timestamp from where report should start. (optional)
String *until = until_example; // The timestamp from where report should stop. (optional)

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

// Get Account reports summary
[apiInstance listAllConversationStatisticsSummaryWith:accountId
    type:type
    id:id
    since:since
    until:until
              completionHandler: ^(account_summary 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.ReportsApi()

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

var type = type_example; // {String} Type of report

var opts = { 
  'id': id_example, // {String} The Id of specific object in case of agent/inbox/label
  'since': since_example, // {String} The timestamp from where report should start.
  'until': until_example // {String} The timestamp from where report should stop.
};

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

namespace Example
{
    public class listAllConversationStatisticsSummaryExample
    {
        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 ReportsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var type = type_example;  // String | Type of report
            var id = id_example;  // String | The Id of specific object in case of agent/inbox/label (optional) 
            var since = since_example;  // String | The timestamp from where report should start. (optional) 
            var until = until_example;  // String | The timestamp from where report should stop. (optional) 

            try
            {
                // Get Account reports summary
                account_summary result = apiInstance.listAllConversationStatisticsSummary(accountId, type, id, since, until);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportsApi.listAllConversationStatisticsSummary: " + 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\ReportsApi();
$accountId = 56; // Integer | The numeric ID of the account
$type = type_example; // String | Type of report
$id = id_example; // String | The Id of specific object in case of agent/inbox/label
$since = since_example; // String | The timestamp from where report should start.
$until = until_example; // String | The timestamp from where report should stop.

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

# 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::ReportsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $type = type_example; # String | Type of report
my $id = id_example; # String | The Id of specific object in case of agent/inbox/label
my $since = since_example; # String | The timestamp from where report should start.
my $until = until_example; # String | The timestamp from where report should stop.

eval { 
    my $result = $api_instance->listAllConversationStatisticsSummary(accountId => $accountId, type => $type, id => $id, since => $since, until => $until);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportsApi->listAllConversationStatisticsSummary: $@\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.ReportsApi()
accountId = 56 # Integer | The numeric ID of the account
type = type_example # String | Type of report
id = id_example # String | The Id of specific object in case of agent/inbox/label (optional)
since = since_example # String | The timestamp from where report should start. (optional)
until = until_example # String | The timestamp from where report should stop. (optional)

try: 
    # Get Account reports summary
    api_response = api_instance.list_all_conversation_statistics_summary(accountId, type, id=id, since=since, until=until)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportsApi->listAllConversationStatisticsSummary: %s\n" % e)

Parameters

Path parameters
Name Description
account_id*
Integer
The numeric ID of the account
Required
Query parameters
Name Description
type*
String
Type of report
Required
id
String
The Id of specific object in case of agent/inbox/label
since
String
The timestamp from where report should start.
until
String
The timestamp from where report should stop.

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - reports not found


Teams

addNewAgentToTeam

Add a New Agent

Add a new Agent to Team


/accounts/{account_id}/teams/{team_id}/team_members

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        Data_15 data = ; // Data_15 | 
        try {
            array[agent] result = apiInstance.addNewAgentToTeam(accountId, teamId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#addNewAgentToTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamsApi;

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        Data_15 data = ; // Data_15 | 
        try {
            array[agent] result = apiInstance.addNewAgentToTeam(accountId, teamId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#addNewAgentToTeam");
            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 *teamId = 56; // The ID of the team to be updated
Data_15 *data = ; // 

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

// Add a New Agent
[apiInstance addNewAgentToTeamWith:accountId
    teamId:teamId
    data:data
              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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated

var data = ; // {Data_15} 


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

namespace Example
{
    public class addNewAgentToTeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated
            var data = new Data_15(); // Data_15 | 

            try
            {
                // Add a New Agent
                array[agent] result = apiInstance.addNewAgentToTeam(accountId, teamId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.addNewAgentToTeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated
$data = ; // Data_15 | 

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated
my $data = WWW::SwaggerClient::Object::Data_15->new(); # Data_15 | 

eval { 
    my $result = $api_instance->addNewAgentToTeam(accountId => $accountId, teamId => $teamId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->addNewAgentToTeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated
data =  # Data_15 | 

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

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Team not found

Status: 422 - User must exist


createATeam

Create a team

Create a team in the account


/api/v1/accounts/{account_id}/teams

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Team_create_update_payload data = ; // Team_create_update_payload | 
        try {
            team result = apiInstance.createATeam(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#createATeam");
            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
Team_create_update_payload *data = ; // 

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

// Create a team
[apiInstance createATeamWith:accountId
    data:data
              completionHandler: ^(team 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.TeamsApi()

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

var data = ; // {Team_create_update_payload} 


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

namespace Example
{
    public class createATeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Team_create_update_payload(); // Team_create_update_payload | 

            try
            {
                // Create a team
                team result = apiInstance.createATeam(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.createATeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Team_create_update_payload | 

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Team_create_update_payload->new(); # Team_create_update_payload | 

eval { 
    my $result = $api_instance->createATeam(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->createATeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Team_create_update_payload | 

try: 
    # Create a team
    api_response = api_instance.create_a_team(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->createATeam: %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


deleteATeam

Delete a team

Delete a team from the account


/api/v1/accounts/{account_id}/teams/{team_id}

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        try {
            apiInstance.deleteATeam(accountId, teamId);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#deleteATeam");
            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 *teamId = 56; // The ID of the team to be updated

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

// Delete a team
[apiInstance deleteATeamWith:accountId
    teamId:teamId
              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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated


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

namespace Example
{
    public class deleteATeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated

            try
            {
                // Delete a team
                apiInstance.deleteATeam(accountId, teamId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.deleteATeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated

eval { 
    $api_instance->deleteATeam(accountId => $accountId, teamId => $teamId);
};
if ($@) {
    warn "Exception when calling TeamsApi->deleteATeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated

try: 
    # Delete a team
    api_instance.delete_a_team(accountId, teamId)
except ApiException as e:
    print("Exception when calling TeamsApi->deleteATeam: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The team does not exist in the account


deleteAgentInTeam

Remove an Agent from Team

Remove an Agent from Team


/accounts/{account_id}/teams/{team_id}/team_members

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        Data_16 data = ; // Data_16 | 
        try {
            apiInstance.deleteAgentInTeam(accountId, teamId, data);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#deleteAgentInTeam");
            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 *teamId = 56; // The ID of the team to be updated
Data_16 *data = ; // 

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

// Remove an Agent from Team
[apiInstance deleteAgentInTeamWith:accountId
    teamId:teamId
    data:data
              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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated

var data = ; // {Data_16} 


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

namespace Example
{
    public class deleteAgentInTeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated
            var data = new Data_16(); // Data_16 | 

            try
            {
                // Remove an Agent from Team
                apiInstance.deleteAgentInTeam(accountId, teamId, data);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.deleteAgentInTeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated
$data = ; // Data_16 | 

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated
my $data = WWW::SwaggerClient::Object::Data_16->new(); # Data_16 | 

eval { 
    $api_instance->deleteAgentInTeam(accountId => $accountId, teamId => $teamId, data => $data);
};
if ($@) {
    warn "Exception when calling TeamsApi->deleteAgentInTeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated
data =  # Data_16 | 

try: 
    # Remove an Agent from Team
    api_instance.delete_agent_in_team(accountId, teamId, data)
except ApiException as e:
    print("Exception when calling TeamsApi->deleteAgentInTeam: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Team not found

Status: 422 - User must exist


getDetailsOfASingleTeam

Get a team details

Get the details of a team in the account


/api/v1/accounts/{account_id}/teams/{team_id}

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        try {
            team result = apiInstance.getDetailsOfASingleTeam(accountId, teamId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#getDetailsOfASingleTeam");
            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 *teamId = 56; // The ID of the team to be updated

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

// Get a team details
[apiInstance getDetailsOfASingleTeamWith:accountId
    teamId:teamId
              completionHandler: ^(team 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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated


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

namespace Example
{
    public class getDetailsOfASingleTeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated

            try
            {
                // Get a team details
                team result = apiInstance.getDetailsOfASingleTeam(accountId, teamId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.getDetailsOfASingleTeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated

eval { 
    my $result = $api_instance->getDetailsOfASingleTeam(accountId => $accountId, teamId => $teamId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->getDetailsOfASingleTeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated

try: 
    # Get a team details
    api_response = api_instance.get_details_of_a_single_team(accountId, teamId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->getDetailsOfASingleTeam: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

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


getTeamMembers

List Agents in Team

Get Details of Agents in an Team


/accounts/{account_id}/teams/{team_id}/team_members

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        try {
            array[agent] result = apiInstance.getTeamMembers(accountId, teamId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#getTeamMembers");
            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 *teamId = 56; // The ID of the team to be updated

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

// List Agents in Team
[apiInstance getTeamMembersWith:accountId
    teamId:teamId
              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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated


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

namespace Example
{
    public class getTeamMembersExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated

            try
            {
                // List Agents in Team
                array[agent] result = apiInstance.getTeamMembers(accountId, teamId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.getTeamMembers: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated

eval { 
    my $result = $api_instance->getTeamMembers(accountId => $accountId, teamId => $teamId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->getTeamMembers: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated

try: 
    # List Agents in Team
    api_response = api_instance.get_team_members(accountId, teamId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->getTeamMembers: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Inbox not found


listAllTeams

List all teams

List all teams available in the current account


/api/v1/accounts/{account_id}/teams

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[team] result = apiInstance.listAllTeams(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#listAllTeams");
            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

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

// List all teams
[apiInstance listAllTeamsWith:accountId
              completionHandler: ^(array[team] 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.TeamsApi()

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.listAllTeams(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllTeamsExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all teams
                array[team] result = apiInstance.listAllTeams(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.listAllTeams: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->listAllTeams(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->listAllTeams: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all teams
    api_response = api_instance.list_all_teams(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->listAllTeams: %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


updateATeam

Update a team

Update a team's attributes


/api/v1/accounts/{account_id}/teams/{team_id}

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

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

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        Team_create_update_payload data = ; // Team_create_update_payload | 
        try {
            team result = apiInstance.updateATeam(accountId, teamId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#updateATeam");
            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 *teamId = 56; // The ID of the team to be updated
Team_create_update_payload *data = ; // 

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

// Update a team
[apiInstance updateATeamWith:accountId
    teamId:teamId
    data:data
              completionHandler: ^(team 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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated

var data = ; // {Team_create_update_payload} 


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

namespace Example
{
    public class updateATeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated
            var data = new Team_create_update_payload(); // Team_create_update_payload | 

            try
            {
                // Update a team
                team result = apiInstance.updateATeam(accountId, teamId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.updateATeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated
$data = ; // Team_create_update_payload | 

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated
my $data = WWW::SwaggerClient::Object::Team_create_update_payload->new(); # Team_create_update_payload | 

eval { 
    my $result = $api_instance->updateATeam(accountId => $accountId, teamId => $teamId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->updateATeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated
data =  # Team_create_update_payload | 

try: 
    # Update a team
    api_response = api_instance.update_a_team(accountId, teamId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->updateATeam: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized


updateAgentsInTeam

Update Agents in Team

All agents except the one passed in params will be removed


/accounts/{account_id}/teams/{team_id}/team_members

Usage and SDK Samples

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

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

public class TeamsApiExample {

    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");

        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        Data_17 data = ; // Data_17 | 
        try {
            array[agent] result = apiInstance.updateAgentsInTeam(accountId, teamId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#updateAgentsInTeam");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TeamsApi;

public class TeamsApiExample {

    public static void main(String[] args) {
        TeamsApi apiInstance = new TeamsApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer teamId = 56; // Integer | The ID of the team to be updated
        Data_17 data = ; // Data_17 | 
        try {
            array[agent] result = apiInstance.updateAgentsInTeam(accountId, teamId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TeamsApi#updateAgentsInTeam");
            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 *teamId = 56; // The ID of the team to be updated
Data_17 *data = ; // 

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

// Update Agents in Team
[apiInstance updateAgentsInTeamWith:accountId
    teamId:teamId
    data:data
              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.TeamsApi()

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

var teamId = 56; // {Integer} The ID of the team to be updated

var data = ; // {Data_17} 


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

namespace Example
{
    public class updateAgentsInTeamExample
    {
        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 TeamsApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var teamId = 56;  // Integer | The ID of the team to be updated
            var data = new Data_17(); // Data_17 | 

            try
            {
                // Update Agents in Team
                array[agent] result = apiInstance.updateAgentsInTeam(accountId, teamId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TeamsApi.updateAgentsInTeam: " + 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\TeamsApi();
$accountId = 56; // Integer | The numeric ID of the account
$teamId = 56; // Integer | The ID of the team to be updated
$data = ; // Data_17 | 

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

# 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::TeamsApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $teamId = 56; # Integer | The ID of the team to be updated
my $data = WWW::SwaggerClient::Object::Data_17->new(); # Data_17 | 

eval { 
    my $result = $api_instance->updateAgentsInTeam(accountId => $accountId, teamId => $teamId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TeamsApi->updateAgentsInTeam: $@\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.TeamsApi()
accountId = 56 # Integer | The numeric ID of the account
teamId = 56 # Integer | The ID of the team to be updated
data =  # Data_17 | 

try: 
    # Update Agents in Team
    api_response = api_instance.update_agents_in_team(accountId, teamId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TeamsApi->updateAgentsInTeam: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 403 - Access denied

Status: 404 - Team not found

Status: 422 - User must exist


Users

createAUser

Create a User

Create a User


/platform/api/v1/users

Usage and SDK Samples

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

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        User_create_update_payload data = ; // User_create_update_payload | 
        try {
            user result = apiInstance.createAUser(data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#createAUser");
            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"];

User_create_update_payload *data = ; // 

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

// Create a User
[apiInstance createAUserWith:data
              completionHandler: ^(user 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.UsersApi()

var data = ; // {User_create_update_payload} 


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

namespace Example
{
    public class createAUserExample
    {
        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 UsersApi();
            var data = new User_create_update_payload(); // User_create_update_payload | 

            try
            {
                // Create a User
                user result = apiInstance.createAUser(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.createAUser: " + 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\UsersApi();
$data = ; // User_create_update_payload | 

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

# 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::UsersApi->new();
my $data = WWW::SwaggerClient::Object::User_create_update_payload->new(); # User_create_update_payload | 

eval { 
    my $result = $api_instance->createAUser(data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->createAUser: $@\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.UsersApi()
data =  # User_create_update_payload | 

try: 
    # Create a User
    api_response = api_instance.create_a_user(data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->createAUser: %s\n" % e)

Parameters

Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


deleteAUser

Delete a User

Delete a User


/platform/api/v1/users/{id}

Usage and SDK Samples

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

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

public class UsersApiExample {

    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");

        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        try {
            apiInstance.deleteAUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteAUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        try {
            apiInstance.deleteAUser(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteAUser");
            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 numeric ID of the user on the platform

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

// Delete a User
[apiInstance deleteAUserWith: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.UsersApi()

var id = 56; // {Integer} The numeric ID of the user on the platform


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

namespace Example
{
    public class deleteAUserExample
    {
        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 UsersApi();
            var id = 56;  // Integer | The numeric ID of the user on the platform

            try
            {
                // Delete a User
                apiInstance.deleteAUser(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteAUser: " + 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\UsersApi();
$id = 56; // Integer | The numeric ID of the user on the platform

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

# 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::UsersApi->new();
my $id = 56; # Integer | The numeric ID of the user on the platform

eval { 
    $api_instance->deleteAUser(id => $id);
};
if ($@) {
    warn "Exception when calling UsersApi->deleteAUser: $@\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.UsersApi()
id = 56 # Integer | The numeric ID of the user on the platform

try: 
    # Delete a User
    api_instance.delete_a_user(id)
except ApiException as e:
    print("Exception when calling UsersApi->deleteAUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The numeric ID of the user on the platform
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The user does not exist


getDetailsOfAUser

Get an user details

Get the details of an user


/platform/api/v1/users/{id}

Usage and SDK Samples

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

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

public class UsersApiExample {

    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");

        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        try {
            user result = apiInstance.getDetailsOfAUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getDetailsOfAUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        try {
            user result = apiInstance.getDetailsOfAUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getDetailsOfAUser");
            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 numeric ID of the user on the platform

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

// Get an user details
[apiInstance getDetailsOfAUserWith:id
              completionHandler: ^(user 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.UsersApi()

var id = 56; // {Integer} The numeric ID of the user on the platform


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

namespace Example
{
    public class getDetailsOfAUserExample
    {
        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 UsersApi();
            var id = 56;  // Integer | The numeric ID of the user on the platform

            try
            {
                // Get an user details
                user result = apiInstance.getDetailsOfAUser(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getDetailsOfAUser: " + 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\UsersApi();
$id = 56; // Integer | The numeric ID of the user on the platform

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

# 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::UsersApi->new();
my $id = 56; # Integer | The numeric ID of the user on the platform

eval { 
    my $result = $api_instance->getDetailsOfAUser(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getDetailsOfAUser: $@\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.UsersApi()
id = 56 # Integer | The numeric ID of the user on the platform

try: 
    # Get an user details
    api_response = api_instance.get_details_of_a_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getDetailsOfAUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The numeric ID of the user on the platform
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given user does not exist


getSsoUrlOfAUser

Get User SSO Link

Get the sso link of a user


/platform/api/v1/users/{id}/login

Usage and SDK Samples

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

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

public class UsersApiExample {

    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");

        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        try {
            inline_response_200_1 result = apiInstance.getSsoUrlOfAUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getSsoUrlOfAUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        try {
            inline_response_200_1 result = apiInstance.getSsoUrlOfAUser(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getSsoUrlOfAUser");
            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 numeric ID of the user on the platform

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

// Get User SSO Link
[apiInstance getSsoUrlOfAUserWith:id
              completionHandler: ^(inline_response_200_1 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.UsersApi()

var id = 56; // {Integer} The numeric ID of the user on the platform


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

namespace Example
{
    public class getSsoUrlOfAUserExample
    {
        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 UsersApi();
            var id = 56;  // Integer | The numeric ID of the user on the platform

            try
            {
                // Get User SSO Link
                inline_response_200_1 result = apiInstance.getSsoUrlOfAUser(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getSsoUrlOfAUser: " + 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\UsersApi();
$id = 56; // Integer | The numeric ID of the user on the platform

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

# 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::UsersApi->new();
my $id = 56; # Integer | The numeric ID of the user on the platform

eval { 
    my $result = $api_instance->getSsoUrlOfAUser(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getSsoUrlOfAUser: $@\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.UsersApi()
id = 56 # Integer | The numeric ID of the user on the platform

try: 
    # Get User SSO Link
    api_response = api_instance.get_sso_url_of_a_user(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->getSsoUrlOfAUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The numeric ID of the user on the platform
Required

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The given user does not exist


updateAUser

Update a user

Update a user's attributes


/platform/api/v1/users/{id}

Usage and SDK Samples

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

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

public class UsersApiExample {

    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");

        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        User_create_update_payload data = ; // User_create_update_payload | 
        try {
            user result = apiInstance.updateAUser(id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateAUser");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.UsersApi;

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | The numeric ID of the user on the platform
        User_create_update_payload data = ; // User_create_update_payload | 
        try {
            user result = apiInstance.updateAUser(id, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateAUser");
            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 numeric ID of the user on the platform
User_create_update_payload *data = ; // 

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

// Update a user
[apiInstance updateAUserWith:id
    data:data
              completionHandler: ^(user 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.UsersApi()

var id = 56; // {Integer} The numeric ID of the user on the platform

var data = ; // {User_create_update_payload} 


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

namespace Example
{
    public class updateAUserExample
    {
        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 UsersApi();
            var id = 56;  // Integer | The numeric ID of the user on the platform
            var data = new User_create_update_payload(); // User_create_update_payload | 

            try
            {
                // Update a user
                user result = apiInstance.updateAUser(id, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateAUser: " + 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\UsersApi();
$id = 56; // Integer | The numeric ID of the user on the platform
$data = ; // User_create_update_payload | 

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

# 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::UsersApi->new();
my $id = 56; # Integer | The numeric ID of the user on the platform
my $data = WWW::SwaggerClient::Object::User_create_update_payload->new(); # User_create_update_payload | 

eval { 
    my $result = $api_instance->updateAUser(id => $id, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->updateAUser: $@\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.UsersApi()
id = 56 # Integer | The numeric ID of the user on the platform
data =  # User_create_update_payload | 

try: 
    # Update a user
    api_response = api_instance.update_a_user(id, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UsersApi->updateAUser: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The numeric ID of the user on the platform
Required
Body parameters
Name Description
data *

Responses

Status: 200 - Success

Status: 401 - Unauthorized


Webhooks

createAWebhook

Add a webhook

Add a webhook subscription to the account


/api/v1/accounts/{account_id}/webhooks

Usage and SDK Samples

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

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

public class WebhooksApiExample {

    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");

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

public class WebhooksApiExample {

    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Webhook_create_update_payload data = ; // Webhook_create_update_payload | 
        try {
            webhook result = apiInstance.createAWebhook(accountId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#createAWebhook");
            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
Webhook_create_update_payload *data = ; // 

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

// Add a webhook
[apiInstance createAWebhookWith:accountId
    data:data
              completionHandler: ^(webhook 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.WebhooksApi()

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

var data = ; // {Webhook_create_update_payload} 


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

namespace Example
{
    public class createAWebhookExample
    {
        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 WebhooksApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var data = new Webhook_create_update_payload(); // Webhook_create_update_payload | 

            try
            {
                // Add a webhook
                webhook result = apiInstance.createAWebhook(accountId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.createAWebhook: " + 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\WebhooksApi();
$accountId = 56; // Integer | The numeric ID of the account
$data = ; // Webhook_create_update_payload | 

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

# 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::WebhooksApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $data = WWW::SwaggerClient::Object::Webhook_create_update_payload->new(); # Webhook_create_update_payload | 

eval { 
    my $result = $api_instance->createAWebhook(accountId => $accountId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->createAWebhook: $@\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.WebhooksApi()
accountId = 56 # Integer | The numeric ID of the account
data =  # Webhook_create_update_payload | 

try: 
    # Add a webhook
    api_response = api_instance.create_a_webhook(accountId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->createAWebhook: %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


deleteAWebhook

Delete a webhook

Delete a webhook from the account


/api/v1/accounts/{account_id}/webhooks/{webhook_id}

Usage and SDK Samples

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

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

public class WebhooksApiExample {

    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");

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

public class WebhooksApiExample {

    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer webhookId = 56; // Integer | The numeric ID of the webhook
        try {
            apiInstance.deleteAWebhook(accountId, webhookId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#deleteAWebhook");
            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 *webhookId = 56; // The numeric ID of the webhook

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

// Delete a webhook
[apiInstance deleteAWebhookWith:accountId
    webhookId:webhookId
              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.WebhooksApi()

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

var webhookId = 56; // {Integer} The numeric ID of the webhook


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

namespace Example
{
    public class deleteAWebhookExample
    {
        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 WebhooksApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var webhookId = 56;  // Integer | The numeric ID of the webhook

            try
            {
                // Delete a webhook
                apiInstance.deleteAWebhook(accountId, webhookId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.deleteAWebhook: " + 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\WebhooksApi();
$accountId = 56; // Integer | The numeric ID of the account
$webhookId = 56; // Integer | The numeric ID of the webhook

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

# 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::WebhooksApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $webhookId = 56; # Integer | The numeric ID of the webhook

eval { 
    $api_instance->deleteAWebhook(accountId => $accountId, webhookId => $webhookId);
};
if ($@) {
    warn "Exception when calling WebhooksApi->deleteAWebhook: $@\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.WebhooksApi()
accountId = 56 # Integer | The numeric ID of the account
webhookId = 56 # Integer | The numeric ID of the webhook

try: 
    # Delete a webhook
    api_instance.delete_a_webhook(accountId, webhookId)
except ApiException as e:
    print("Exception when calling WebhooksApi->deleteAWebhook: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized

Status: 404 - The webhook does not exist in the account


listAllWebhooks

List all webhooks

List all webhooks in the account


/api/v1/accounts/{account_id}/webhooks

Usage and SDK Samples

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

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

public class WebhooksApiExample {

    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");

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

public class WebhooksApiExample {

    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        try {
            array[webhook] result = apiInstance.listAllWebhooks(accountId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#listAllWebhooks");
            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

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

// List all webhooks
[apiInstance listAllWebhooksWith:accountId
              completionHandler: ^(array[webhook] 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.WebhooksApi()

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.listAllWebhooks(accountId, , callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class listAllWebhooksExample
    {
        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 WebhooksApi();
            var accountId = 56;  // Integer | The numeric ID of the account

            try
            {
                // List all webhooks
                array[webhook] result = apiInstance.listAllWebhooks(accountId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.listAllWebhooks: " + 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\WebhooksApi();
$accountId = 56; // Integer | The numeric ID of the account

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

# 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::WebhooksApi->new();
my $accountId = 56; # Integer | The numeric ID of the account

eval { 
    my $result = $api_instance->listAllWebhooks(accountId => $accountId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->listAllWebhooks: $@\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.WebhooksApi()
accountId = 56 # Integer | The numeric ID of the account

try: 
    # List all webhooks
    api_response = api_instance.list_all_webhooks(accountId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->listAllWebhooks: %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


updateAWebhook

Update a webhook object

Update a webhook object in the account


/api/v1/accounts/{account_id}/webhooks/{webhook_id}

Usage and SDK Samples

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

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

public class WebhooksApiExample {

    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");

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

public class WebhooksApiExample {

    public static void main(String[] args) {
        WebhooksApi apiInstance = new WebhooksApi();
        Integer accountId = 56; // Integer | The numeric ID of the account
        Integer webhookId = 56; // Integer | The numeric ID of the webhook
        Webhook_create_update_payload data = ; // Webhook_create_update_payload | 
        try {
            webhook result = apiInstance.updateAWebhook(accountId, webhookId, data);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebhooksApi#updateAWebhook");
            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 *webhookId = 56; // The numeric ID of the webhook
Webhook_create_update_payload *data = ; // 

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

// Update a webhook object
[apiInstance updateAWebhookWith:accountId
    webhookId:webhookId
    data:data
              completionHandler: ^(webhook 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.WebhooksApi()

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

var webhookId = 56; // {Integer} The numeric ID of the webhook

var data = ; // {Webhook_create_update_payload} 


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

namespace Example
{
    public class updateAWebhookExample
    {
        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 WebhooksApi();
            var accountId = 56;  // Integer | The numeric ID of the account
            var webhookId = 56;  // Integer | The numeric ID of the webhook
            var data = new Webhook_create_update_payload(); // Webhook_create_update_payload | 

            try
            {
                // Update a webhook object
                webhook result = apiInstance.updateAWebhook(accountId, webhookId, data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebhooksApi.updateAWebhook: " + 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\WebhooksApi();
$accountId = 56; // Integer | The numeric ID of the account
$webhookId = 56; // Integer | The numeric ID of the webhook
$data = ; // Webhook_create_update_payload | 

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

# 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::WebhooksApi->new();
my $accountId = 56; # Integer | The numeric ID of the account
my $webhookId = 56; # Integer | The numeric ID of the webhook
my $data = WWW::SwaggerClient::Object::Webhook_create_update_payload->new(); # Webhook_create_update_payload | 

eval { 
    my $result = $api_instance->updateAWebhook(accountId => $accountId, webhookId => $webhookId, data => $data);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebhooksApi->updateAWebhook: $@\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.WebhooksApi()
accountId = 56 # Integer | The numeric ID of the account
webhookId = 56 # Integer | The numeric ID of the webhook
data =  # Webhook_create_update_payload | 

try: 
    # Update a webhook object
    api_response = api_instance.update_a_webhook(accountId, webhookId, data)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling WebhooksApi->updateAWebhook: %s\n" % e)

Parameters

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

Responses

Status: 200 - Success

Status: 401 - Unauthorized