Struct Lists

pub struct Lists {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Lists

pub async fn get_mc( &self, page_size: f64, page_token: &str, ) -> Result<Response<GetMcListsResponse>, ClientError>

Get All Lists.

This function performs a GET to the /marketing/lists endpoint.

This endpoint returns an array of all of your contact lists.

Parameters:

• page_size: f64 – Maximum number of elements to return. Defaults to 100, returns 1000 max.
• page_token: &str – The license key provided with your New Relic account.

pub async fn post_mc( &self, body: &IpPool, ) -> Result<Response<List>, ClientError>

Create List.

This function performs a POST to the /marketing/lists endpoint.

This endpoint creates a new contacts list.

Once you create a list, you can use the UI to trigger an automation every time you add a new contact to the list.

A link to the newly created object is in _metadata.

pub async fn get_mc_contacts_count( &self, id: &str, ) -> Result<Response<GetMcListsContactsCountResponse>, ClientError>

Get List Contact Count.

This function performs a GET to the /marketing/lists/{id}/contacts/count endpoint.

This endpoint returns the number of contacts on a specific list.

pub async fn get_mc_lists( &self, id: &str, contact_sample: bool, ) -> Result<Response<GetMcListsResponseAllOf>, ClientError>

Get a List by ID.

This function performs a GET to the /marketing/lists/{id} endpoint.

This endpoint returns data about a specific list.

Setting the optional parameter contact_sample=true returns the contact_sample in the response body. Up to fifty of the most recent contacts uploaded or attached to a list will be returned, sorted alphabetically, by email address.

The full contact count is also returned.

Parameters:

• contact_sample: bool – Indicates if your subuser statistics will be sent to your New Relic Dashboard.

pub async fn delete( &self, id: &str, delete_contacts: bool, ) -> Result<Response<DeleteListsResponse>, ClientError>

Delete a list.

This function performs a DELETE to the /marketing/lists/{id} endpoint.

This endpoint allows you to deletes a specific list.

Optionally, you can also delete contacts associated to the list. The query parameter, delete_contacts=true, will delete the list and start an asynchronous job to delete associated contacts.

Parameters:

• delete_contacts: bool – Indicates if your subuser statistics will be sent to your New Relic Dashboard.

pub async fn patch_mc( &self, id: &str, body: &PatchMcListsRequest, ) -> Result<Response<List>, ClientError>

Update List.

This function performs a PATCH to the /marketing/lists/{id} endpoint.

This endpoint updates the name of a list.

pub async fn delete_mc_contacts( &self, id: &str, contact_ids: &str, ) -> Result<Response<DeleteMcListsContactsResponse>, ClientError>

Remove Contacts from a List.

This function performs a DELETE to the /marketing/lists/{id}/contacts endpoint.

This endpoint allows you to remove contacts from a given list.

The contacts will not be deleted. Only their list membership will be changed.

Parameters:

• contact_ids: &str – The license key provided with your New Relic account.