Struct sendgrid_api::campaigns_api::CampaignsApi

pub struct CampaignsApi {
    pub client: Client,
}

Fields

client: Client

Implementations

impl CampaignsApi

pub async fn get_campaigns(
    &self,
    limit: i64,
    offset: i64
) -> Result<GetCampaignsResponse>

Retrieve all Campaigns.

This function performs a GET to the /campaigns endpoint.

This endpoint allows you to retrieve a list of all of your campaigns.

Returns campaigns in reverse order they were created (newest first).

Returns an empty array if no campaigns exist.

Parameters:

• limit: i64 – The number of results you would like to receive at a time.
• offset: i64 – The index of the first campaign to return, where 0 is the first campaign.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn post_campaign(
    &self,
    body: &CampaignsRequest
) -> Result<CampaignResponseAllOf>

Create a Campaign.

This function performs a POST to the /campaigns endpoint.

This endpoint allows you to create a campaign.

In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign.

Parameters:

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

pub async fn get_campaigns_campaign(
    &self,
    campaign_id: i64
) -> Result<GetCampaignsCampaignResponse>

Retrieve a single campaign.

This function performs a GET to the /campaigns/{campaign_id} endpoint.

This endpoint allows you to retrieve a specific campaign.

Parameters:

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

pub async fn delete_campaigns_campaign(&self, campaign_id: i64) -> Result<()>

Delete a Campaign.

This function performs a DELETE to the /campaigns/{campaign_id} endpoint.

This endpoint allows you to delete a specific campaign.

Parameters:

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

pub async fn patch_campaigns_campaign(
    &self,
    campaign_id: i64,
    body: &UpdateACampaignRequest
) -> Result<CampaignResponseAllOf>

Update a Campaign.

This function performs a PATCH to the /campaigns/{campaign_id} endpoint.

This endpoint allows you to update a specific campaign.

This is especially useful if you only set up the campaign using POST /campaigns, but didn’t set many of the parameters.

Parameters:

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

pub async fn post_campaigns_campaign_schedules_now(
    &self,
    campaign_id: i64
) -> Result<SendACampaignResponse>

Send a Campaign.

This function performs a POST to the /campaigns/{campaign_id}/schedules/now endpoint.

This endpoint allows you to immediately send an existing campaign.

Normally a POST request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed.

Parameters:

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

pub async fn get_campaigns_campaign_schedule(
    &self,
    campaign_id: i64
) -> Result<ScheduleACampaignRequest>

View Scheduled Time of a Campaign.

This function performs a GET to the /campaigns/{campaign_id}/schedules endpoint.

This endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.

Parameters:

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

pub async fn post_campaigns_campaign_schedule(
    &self,
    campaign_id: i64,
    body: &ScheduleACampaignRequest
) -> Result<ScheduleACampaignResponse>

Schedule a Campaign.

This function performs a POST to the /campaigns/{campaign_id}/schedules endpoint.

This endpoint allows you to schedule a specific date and time for your campaign to be sent.

If you have the flexibility, it’s better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won’t be going through our servers at the same times as everyone else’s mail.

Parameters:

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

pub async fn delete_campaigns_campaign_schedules(
    &self,
    campaign_id: i64
) -> Result<()>

Unschedule a Scheduled Campaign.

This function performs a DELETE to the /campaigns/{campaign_id}/schedules endpoint.

This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.

A successful unschedule will return a 204. If the specified campaign is in the process of being sent, the only option is to cancel (a different method).

Parameters:

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

pub async fn patch_campaigns_campaign_schedules(
    &self,
    campaign_id: i64,
    body: &ScheduleACampaignRequest
) -> Result<UpdateAScheduledCampaignResponse>

Update a Scheduled Campaign.

This function performs a PATCH to the /campaigns/{campaign_id}/schedules endpoint.

This endpoint allows to you change the scheduled time and date for a campaign to be sent.

Parameters:

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

pub async fn post_campaigns_campaign_schedules_test(
    &self,
    campaign_id: i64,
    body: &SendATestCampaignRequest
) -> Result<SendATestCampaignRequest>

Send a Test Campaign.

This function performs a POST to the /campaigns/{campaign_id}/schedules/test endpoint.

This endpoint allows you to send a test campaign.

To send to multiple addresses, use an array for the JSON “to” value [“one@address”,“two@address”]

Parameters:

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