Skip to content

Latest commit

 

History

History
266 lines (183 loc) · 7.09 KB

ListsApi.md

File metadata and controls

266 lines (183 loc) · 7.09 KB
Raw

bombbomb.ListsApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
add_new_list POST /lists/ Add list.
clear_list PUT /lists/{listId}/clear Clear Contacts from List
copy_list_contacts POST /lists/{listId}/copy Copy All Contacts from a List
get_all_lists GET /lists/ Get all Lists
suppress_all_in_list PUT /lists/{listId}/suppress Suppress All Contacts from List

add_new_list

add_new_list(list_name)

Add list.

Add a list to the users account.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.ListsApi(bombbomb.ApiClient(configuration))
list_name = 'list_name_example' # str | Name of the new list being added

try:
    # Add list.
    api_instance.add_new_list(list_name)
except ApiException as e:
    print("Exception when calling ListsApi->add_new_list: %s\n" % e)

Parameters

Name Type Description Notes
list_name str Name of the new list being added

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

clear_list

clear_list(list_id)

Clear Contacts from List

Clears all contacts from a list.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.ListsApi(bombbomb.ApiClient(configuration))
list_id = 'list_id_example' # str | The list to be cleared.

try:
    # Clear Contacts from List
    api_instance.clear_list(list_id)
except ApiException as e:
    print("Exception when calling ListsApi->clear_list: %s\n" % e)

Parameters

Name Type Description Notes
list_id str The list to be cleared.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

copy_list_contacts

copy_list_contacts(from_list_id, list_id)

Copy All Contacts from a List

Copy all contacts from a list.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.ListsApi(bombbomb.ApiClient(configuration))
from_list_id = 'from_list_id_example' # str | The list to be cleared.
list_id = 'list_id_example' # str | The list to be cleared.

try:
    # Copy All Contacts from a List
    api_instance.copy_list_contacts(from_list_id, list_id)
except ApiException as e:
    print("Exception when calling ListsApi->copy_list_contacts: %s\n" % e)

Parameters

Name Type Description Notes
from_list_id str The list to be cleared.
list_id str The list to be cleared.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

get_all_lists

get_all_lists()

Get all Lists

Get all the lists for a specific user.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.ListsApi(bombbomb.ApiClient(configuration))

try:
    # Get all Lists
    api_instance.get_all_lists()
except ApiException as e:
    print("Exception when calling ListsApi->get_all_lists: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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

suppress_all_in_list

suppress_all_in_list(list_id)

Suppress All Contacts from List

Suppresses all contacts in a list.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.ListsApi(bombbomb.ApiClient(configuration))
list_id = 'list_id_example' # str | The list to be cleared.

try:
    # Suppress All Contacts from List
    api_instance.suppress_all_in_list(list_id)
except ApiException as e:
    print("Exception when calling ListsApi->suppress_all_in_list: %s\n" % e)

Parameters

Name Type Description Notes
list_id str The list to be cleared.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

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