AccountGroupsApi

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

Method	HTTP request	Description
createAccountGroup	POST /v1/account-groups	Create group
createAccountGroupWithHttpInfo	POST /v1/account-groups	Create group
deleteAccountGroup	DELETE /v1/account-groups/{groupId}	Delete group
deleteAccountGroupWithHttpInfo	DELETE /v1/account-groups/{groupId}	Delete group
listAccountGroups	GET /v1/account-groups	List groups
listAccountGroupsWithHttpInfo	GET /v1/account-groups	List groups
updateAccountGroup	PUT /v1/account-groups/{groupId}	Update group
updateAccountGroupWithHttpInfo	PUT /v1/account-groups/{groupId}	Update group

createAccountGroup

CreateAccountGroup201Response createAccountGroup(createAccountGroupRequest)

Create group

Creates a new account group with a name and a list of social account IDs. Accounts can belong to different profiles; the caller must have access to every account's profile. Group names must be unique per user.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        CreateAccountGroupRequest createAccountGroupRequest = new CreateAccountGroupRequest(); // CreateAccountGroupRequest | 
        try {
            CreateAccountGroup201Response result = apiInstance.createAccountGroup(createAccountGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#createAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
createAccountGroupRequest	CreateAccountGroupRequest

Return type

CreateAccountGroup201Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Invalid request	-
401	Unauthorized	-
409	Group name already exists	-

createAccountGroupWithHttpInfo

ApiResponse createAccountGroup createAccountGroupWithHttpInfo(createAccountGroupRequest)

Create group

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.ApiResponse;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        CreateAccountGroupRequest createAccountGroupRequest = new CreateAccountGroupRequest(); // CreateAccountGroupRequest | 
        try {
            ApiResponse<CreateAccountGroup201Response> response = apiInstance.createAccountGroupWithHttpInfo(createAccountGroupRequest);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#createAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
createAccountGroupRequest	CreateAccountGroupRequest

Return type

ApiResponse<CreateAccountGroup201Response>

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Invalid request	-
401	Unauthorized	-
409	Group name already exists	-

deleteAccountGroup

DeleteAccountGroup200Response deleteAccountGroup(groupId)

Delete group

Permanently deletes an account group. The accounts themselves are not affected.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String groupId = "groupId_example"; // String | 
        try {
            DeleteAccountGroup200Response result = apiInstance.deleteAccountGroup(groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#deleteAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
groupId	String

Return type

DeleteAccountGroup200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Deleted	-
401	Unauthorized	-
404	Resource not found	-

deleteAccountGroupWithHttpInfo

ApiResponse deleteAccountGroup deleteAccountGroupWithHttpInfo(groupId)

Delete group

Permanently deletes an account group. The accounts themselves are not affected.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.ApiResponse;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String groupId = "groupId_example"; // String | 
        try {
            ApiResponse<DeleteAccountGroup200Response> response = apiInstance.deleteAccountGroupWithHttpInfo(groupId);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#deleteAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
groupId	String

Return type

ApiResponse<DeleteAccountGroup200Response>

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Deleted	-
401	Unauthorized	-
404	Resource not found	-

listAccountGroups

ListAccountGroups200Response listAccountGroups()

List groups

Returns all account groups visible to the authenticated user. Groups can contain accounts from multiple profiles. For API keys scoped to specific profiles, only groups whose accounts all live in allowed profiles are returned.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        try {
            ListAccountGroups200Response result = apiInstance.listAccountGroups();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#listAccountGroups");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListAccountGroups200Response

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Groups	-
401	Unauthorized	-

listAccountGroupsWithHttpInfo

ApiResponse listAccountGroups listAccountGroupsWithHttpInfo()

List groups

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.ApiResponse;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        try {
            ApiResponse<ListAccountGroups200Response> response = apiInstance.listAccountGroupsWithHttpInfo();
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#listAccountGroups");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ApiResponse<ListAccountGroups200Response>

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Groups	-
401	Unauthorized	-

updateAccountGroup

UpdateAccountGroup200Response updateAccountGroup(groupId, updateAccountGroupRequest)

Update group

Updates the name or account list of an existing group. You can rename the group, change its accounts, or both.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String groupId = "groupId_example"; // String | 
        UpdateAccountGroupRequest updateAccountGroupRequest = new UpdateAccountGroupRequest(); // UpdateAccountGroupRequest | 
        try {
            UpdateAccountGroup200Response result = apiInstance.updateAccountGroup(groupId, updateAccountGroupRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#updateAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
groupId	String
updateAccountGroupRequest	UpdateAccountGroupRequest

Return type

UpdateAccountGroup200Response

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated	-
401	Unauthorized	-
404	Resource not found	-
409	Group name already exists	-

updateAccountGroupWithHttpInfo

ApiResponse updateAccountGroup updateAccountGroupWithHttpInfo(groupId, updateAccountGroupRequest)

Update group

Updates the name or account list of an existing group. You can rename the group, change its accounts, or both.

Example

// Import classes:
import dev.zernio.ApiClient;
import dev.zernio.ApiException;
import dev.zernio.ApiResponse;
import dev.zernio.Configuration;
import dev.zernio.auth.*;
import dev.zernio.models.*;
import dev.zernio.api.AccountGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://zernio.com/api");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccountGroupsApi apiInstance = new AccountGroupsApi(defaultClient);
        String groupId = "groupId_example"; // String | 
        UpdateAccountGroupRequest updateAccountGroupRequest = new UpdateAccountGroupRequest(); // UpdateAccountGroupRequest | 
        try {
            ApiResponse<UpdateAccountGroup200Response> response = apiInstance.updateAccountGroupWithHttpInfo(groupId, updateAccountGroupRequest);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling AccountGroupsApi#updateAccountGroup");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name	Type	Description	Notes
groupId	String
updateAccountGroupRequest	UpdateAccountGroupRequest

Return type

ApiResponse<UpdateAccountGroup200Response>

Authorization

bearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Updated	-
401	Unauthorized	-
404	Resource not found	-
409	Group name already exists	-

Uh oh!

FilesExpand file tree

AccountGroupsApi.md

Latest commit

History

AccountGroupsApi.md

File metadata and controls

AccountGroupsApi

createAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listAccountGroups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listAccountGroupsWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateAccountGroup

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateAccountGroupWithHttpInfo

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details