Skip to content

Latest commit

 

History

History
150 lines (92 loc) · 4.22 KB

ListsApi.md

File metadata and controls

150 lines (92 loc) · 4.22 KB

\ListsApi

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

Method HTTP request Description
AddNewList Post /lists/ Add list.
ClearList Put /lists/{listId}/clear Clear Contacts from List
CopyListContacts Post /lists/{listId}/copy Copy All Contacts from a List
GetAllLists Get /lists/ Get all Lists
SuppressAllInList Put /lists/{listId}/suppress Suppress All Contacts from List

AddNewList

AddNewList(ctx, listName) Add list.

Add a list to the users account.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
listName string Name of the new list being added

Return type

(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]

ClearList

ClearList(ctx, listId) Clear Contacts from List

Clears all contacts from a list.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
listId string The list to be cleared.

Return type

(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]

CopyListContacts

CopyListContacts(ctx, fromListId, listId) Copy All Contacts from a List

Copy all contacts from a list.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
fromListId string The list to be cleared.
listId string The list to be cleared.

Return type

(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]

GetAllLists

GetAllLists(ctx, ) Get all Lists

Get all the lists for a specific user.

Required Parameters

This endpoint does not need any parameter.

Return type

(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]

SuppressAllInList

SuppressAllInList(ctx, listId) Suppress All Contacts from List

Suppresses all contacts in a list.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
listId string The list to be cleared.

Return type

(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]