pub struct LoopsOpenApiSpecClient {
pub client: Client,
pub base_url: Url,
}Fields§
§client: Client§base_url: UrlImplementations§
Source§impl LoopsOpenApiSpecClient
impl LoopsOpenApiSpecClient
Sourcepub fn with_base_url(base_url: impl AsRef<str>) -> Result<Self>
pub fn with_base_url(base_url: impl AsRef<str>) -> Result<Self>
Create a client with a custom base URL.
Sourcepub fn with_client(base_url: impl AsRef<str>, client: Client) -> Result<Self>
pub fn with_client(base_url: impl AsRef<str>, client: Client) -> Result<Self>
Create a client from an existing reqwest::Client.
Sourcepub async fn test_api_key(
&self,
request: TestApiKeyRequest,
) -> Result<TestApiKeyResponse>
pub async fn test_api_key( &self, request: TestApiKeyRequest, ) -> Result<TestApiKeyResponse>
API key
Test your API key and get team context.
- Path:
GET /v1/api-key
Sourcepub async fn get_audience_segment(
&self,
request: GetAudienceSegmentRequest,
) -> Result<GetAudienceSegmentResponse>
pub async fn get_audience_segment( &self, request: GetAudienceSegmentRequest, ) -> Result<GetAudienceSegmentResponse>
Get an audience segment
Retrieve a single audience segment by ID.
- Path:
GET /v1/audience-segments/{audienceSegmentId}
Sourcepub async fn list_audience_segments(
&self,
request: ListAudienceSegmentsRequest,
) -> Result<ListAudienceSegmentsResponseEnum>
pub async fn list_audience_segments( &self, request: ListAudienceSegmentsRequest, ) -> Result<ListAudienceSegmentsResponseEnum>
List audience segments
Retrieve a paginated list of audience segments, most recently created first.
- Path:
GET /v1/audience-segments
Sourcepub async fn create_audience_segment(
&self,
request: CreateAudienceSegmentRequestParams,
) -> Result<GetAudienceSegmentResponse>
pub async fn create_audience_segment( &self, request: CreateAudienceSegmentRequestParams, ) -> Result<GetAudienceSegmentResponse>
Create an audience segment
Create a new audience segment.
- Path:
POST /v1/audience-segments
Sourcepub async fn list_campaigns(
&self,
request: ListCampaignsRequest,
) -> Result<ListCampaignsResponseEnum>
pub async fn list_campaigns( &self, request: ListCampaignsRequest, ) -> Result<ListCampaignsResponseEnum>
List campaigns
Retrieve a paginated list of campaigns.
- Path:
GET /v1/campaigns
Sourcepub async fn create_campaign(
&self,
request: CreateCampaignRequestParams,
) -> Result<CreateCampaignResponseEnum>
pub async fn create_campaign( &self, request: CreateCampaignRequestParams, ) -> Result<CreateCampaignResponseEnum>
Create a campaign
Create a new draft campaign. An empty email message is created automatically and its emailMessageId is returned. Use the /email-messages/{emailMessageId} endpoint to set subject, sender, preview text, and LMX content. The audience (mailing list, segment, or filter), group, and scheduling can be set on create or later via update.
- Path:
POST /v1/campaigns
Sourcepub async fn get_campaign(
&self,
request: GetCampaignRequest,
) -> Result<GetCampaignResponse>
pub async fn get_campaign( &self, request: GetCampaignRequest, ) -> Result<GetCampaignResponse>
Get a campaign
Retrieve a single campaign by ID.
- Path:
GET /v1/campaigns/{campaignId}
Sourcepub async fn update_campaign(
&self,
request: UpdateCampaignRequestParams,
) -> Result<UpdateCampaignResponse>
pub async fn update_campaign( &self, request: UpdateCampaignRequestParams, ) -> Result<UpdateCampaignResponse>
Update a campaign
Update a draft campaign’s name, group, audience (mailing list, segment, or filter), or scheduling. At least one field must be provided. Once a campaign has been sent, only its name and campaignGroupId can be updated.
- Path:
POST /v1/campaigns/{campaignId}
Sourcepub async fn get_campaign_metrics(
&self,
request: GetCampaignMetricsRequest,
) -> Result<GetCampaignMetricsResponse>
pub async fn get_campaign_metrics( &self, request: GetCampaignMetricsRequest, ) -> Result<GetCampaignMetricsResponse>
Get campaign metrics
Retrieve all-time email engagement metrics for a campaign.
- Path:
GET /v1/campaigns/{campaignId}/metrics
Sourcepub async fn list_campaign_groups(
&self,
request: ListCampaignGroupsRequest,
) -> Result<ListCampaignGroupsResponse>
pub async fn list_campaign_groups( &self, request: ListCampaignGroupsRequest, ) -> Result<ListCampaignGroupsResponse>
List campaign groups
Retrieve a paginated list of campaign groups, most recently created first.
- Path:
GET /v1/campaign-groups
Sourcepub async fn create_campaign_group(
&self,
request: CreateCampaignGroupRequest,
) -> Result<CreateCampaignGroupResponse>
pub async fn create_campaign_group( &self, request: CreateCampaignGroupRequest, ) -> Result<CreateCampaignGroupResponse>
Create a campaign group
Create a new campaign group.
- Path:
POST /v1/campaign-groups
Sourcepub async fn get_campaign_group(
&self,
request: GetCampaignGroupRequest,
) -> Result<GetCampaignGroupResponse>
pub async fn get_campaign_group( &self, request: GetCampaignGroupRequest, ) -> Result<GetCampaignGroupResponse>
Get a campaign group
Retrieve a single campaign group by ID.
- Path:
GET /v1/campaign-groups/{campaignGroupId}
Sourcepub async fn update_campaign_group(
&self,
request: UpdateCampaignGroupRequest,
) -> Result<GetCampaignGroupResponse>
pub async fn update_campaign_group( &self, request: UpdateCampaignGroupRequest, ) -> Result<GetCampaignGroupResponse>
Update a campaign group
Update a campaign group’s name or description. At least one field must be provided. The reserved “Unsorted” group cannot be edited.
- Path:
POST /v1/campaign-groups/{campaignGroupId}
Sourcepub async fn list_dedicated_sending_ips(
&self,
request: ListDedicatedSendingIpsRequest,
) -> Result<ListDedicatedSendingIpsResponse>
pub async fn list_dedicated_sending_ips( &self, request: ListDedicatedSendingIpsRequest, ) -> Result<ListDedicatedSendingIpsResponse>
List dedicated sending IP addresses
Retrieve a list of Loops’ dedicated sending IP addresses.
This endpoint is provided for the rare instances where you may need to whitelist our sending IPs. Please note that this list is subject to change and will not include shared IPs used for sending mail.
Unless you are sure you need this and are comfortable watching for changes, we strongly recommend you do not whitelist these IPs.
- Path:
GET /v1/dedicated-sending-ips
Sourcepub async fn create_contact(
&self,
request: CreateContactRequest,
) -> Result<CreateContactResponse>
pub async fn create_contact( &self, request: CreateContactRequest, ) -> Result<CreateContactResponse>
Create a contact
Add a contact to your audience.
- Path:
POST /v1/contacts/create
Sourcepub async fn update_contact(
&self,
request: UpdateContactRequest,
) -> Result<UpdateContactResponse>
pub async fn update_contact( &self, request: UpdateContactRequest, ) -> Result<UpdateContactResponse>
Update a contact
Update a contact by email or userId. You must provide one of these parameters.
If you want to update a contact’s email address, the contact will first need a userId value. You can then make a request containing the userId field along with an updated email address.
This endpoint will create a contact if a matching contact does not already exist in your audience.
Provide either email or userId to identify the contact you want to update. If both are provided, the system will look for a contact with either a matching email or userId value. If a contact is found for one of the values (e.g. email), the other value (e.g. userId) will be updated. If a contact is not found, a new contact will be created using both email and userId values.
- Path:
PUT /v1/contacts/update
Sourcepub async fn find_contact(
&self,
request: FindContactRequest,
) -> Result<FindContactResponse>
pub async fn find_contact( &self, request: FindContactRequest, ) -> Result<FindContactResponse>
Find a contact
Search for a contact by email or userId. Only one parameter is allowed.
- Path:
GET /v1/contacts/find
Sourcepub async fn delete_contact(
&self,
request: DeleteContactRequest,
) -> Result<DeleteContactResponse>
pub async fn delete_contact( &self, request: DeleteContactRequest, ) -> Result<DeleteContactResponse>
Delete a contact
Delete a contact by email or userId.
- Path:
POST /v1/contacts/delete
Sourcepub async fn get_contact_suppression(
&self,
request: GetContactSuppressionRequest,
) -> Result<GetContactSuppressionResponse>
pub async fn get_contact_suppression( &self, request: GetContactSuppressionRequest, ) -> Result<GetContactSuppressionResponse>
Get suppression status for a contact
Retrieve suppression status and removal quota for a contact by email or userId. Include only one query parameter.
- Path:
GET /v1/contacts/suppression
Sourcepub async fn remove_contact_suppression(
&self,
request: RemoveContactSuppressionRequest,
) -> Result<RemoveContactSuppressionResponse>
pub async fn remove_contact_suppression( &self, request: RemoveContactSuppressionRequest, ) -> Result<RemoveContactSuppressionResponse>
Remove a contact from suppression list
Remove a suppressed contact from the suppression list by email or userId. Include only one query parameter.
- Path:
DELETE /v1/contacts/suppression
Sourcepub async fn list_contact_properties(
&self,
request: ListContactPropertiesRequest,
) -> Result<ListContactPropertiesResponse>
pub async fn list_contact_properties( &self, request: ListContactPropertiesRequest, ) -> Result<ListContactPropertiesResponse>
List contact properties
Retrieve a list of your account’s contact properties.
Use the list parameter to query “all” or “custom” properties.
- Path:
GET /v1/contacts/properties
Sourcepub async fn create_contact_property(
&self,
request: CreateContactPropertyRequest,
) -> Result<CreateContactPropertyResponse>
pub async fn create_contact_property( &self, request: CreateContactPropertyRequest, ) -> Result<CreateContactPropertyResponse>
Create a contact property
Create a custom contact property.
- Path:
POST /v1/contacts/properties
Sourcepub async fn get_component(
&self,
request: GetComponentRequest,
) -> Result<GetComponentResponse>
pub async fn get_component( &self, request: GetComponentRequest, ) -> Result<GetComponentResponse>
Get a component
Retrieve a single component by ID.
- Path:
GET /v1/components/{componentId}
Sourcepub async fn update_component(
&self,
request: UpdateComponentRequest,
) -> Result<UpdateComponentResponseEnum>
pub async fn update_component( &self, request: UpdateComponentRequest, ) -> Result<UpdateComponentResponseEnum>
Update a component
Update a component’s name and/or body. When the lmx body changes, the update cascades to every email using this component, and affectedEmailCount reports how many were affected. A change that would introduce a dynamic variable an email using the component cannot use is rejected.
- Path:
POST /v1/components/{componentId}
Sourcepub async fn list_components(
&self,
request: ListComponentsRequest,
) -> Result<ListComponentsResponseEnum>
pub async fn list_components( &self, request: ListComponentsRequest, ) -> Result<ListComponentsResponseEnum>
List components
Retrieve a paginated list of email components.
- Path:
GET /v1/components
Sourcepub async fn create_component(
&self,
request: CreateComponentRequest,
) -> Result<CreateComponentResponse>
pub async fn create_component( &self, request: CreateComponentRequest, ) -> Result<CreateComponentResponse>
Create a component
Create a new email component from an LMX body.
- Path:
POST /v1/components
Sourcepub async fn get_email_message(
&self,
request: GetEmailMessageRequest,
) -> Result<GetEmailMessageResponse>
pub async fn get_email_message( &self, request: GetEmailMessageRequest, ) -> Result<GetEmailMessageResponse>
Get an email message
Retrieve an email message, including its compiled LMX content.
- Path:
GET /v1/email-messages/{emailMessageId}
Sourcepub async fn update_email_message(
&self,
request: UpdateEmailMessageRequestParams,
) -> Result<UpdateEmailMessageResponse>
pub async fn update_email_message( &self, request: UpdateEmailMessageRequestParams, ) -> Result<UpdateEmailMessageResponse>
Update an email message
Update fields on an email message (subject, preview text, sender, LMX content). The campaign must be in draft status. Supply expectedRevisionId matching the current contentRevisionId — the server rejects mismatched revisions with 409.
- Path:
POST /v1/email-messages/{emailMessageId}
Sourcepub async fn preview_email_message(
&self,
request: PreviewEmailMessageRequest,
) -> Result<PreviewEmailMessageResponse>
pub async fn preview_email_message( &self, request: PreviewEmailMessageRequest, ) -> Result<PreviewEmailMessageResponse>
Send a preview of an email message
Send a test preview of an email message to one or more addresses. The accepted variable fields depend on the parent’s type - campaign previews accept contactProperties, workflow previews accept contactProperties and eventProperties, and transactional previews accept dataVariables. Supplying a field the parent cannot reference is rejected with 400.
- Path:
POST /v1/email-messages/{emailMessageId}/preview
Sourcepub async fn get_email_message_guardian(
&self,
request: GetEmailMessageGuardianRequest,
) -> Result<GetEmailMessageGuardianResponse>
pub async fn get_email_message_guardian( &self, request: GetEmailMessageGuardianRequest, ) -> Result<GetEmailMessageGuardianResponse>
Run Guardian checks on an email message
Validate an email message’s content against Guardian rules and return any errors and warnings. Errors must be resolved before the email can be published, warnings are advisory.
- Path:
GET /v1/email-messages/{emailMessageId}/guardian
Sourcepub async fn send_event(
&self,
request: SendEventRequest,
) -> Result<SendEventResponse>
pub async fn send_event( &self, request: SendEventRequest, ) -> Result<SendEventResponse>
Send an event
Send events to trigger workflows.
- Path:
POST /v1/events/send
Sourcepub async fn list_event_patterns(
&self,
request: ListEventPatternsRequest,
) -> Result<ListEventPatternsResponseEnum>
pub async fn list_event_patterns( &self, request: ListEventPatternsRequest, ) -> Result<ListEventPatternsResponseEnum>
List event patterns
Retrieve a paginated list of event patterns available to workflow event trigger nodes.
- Path:
GET /v1/event-patterns
Sourcepub async fn get_event_pattern_by_name(
&self,
request: GetEventPatternByNameRequest,
) -> Result<GetEventPatternResponse>
pub async fn get_event_pattern_by_name( &self, request: GetEventPatternByNameRequest, ) -> Result<GetEventPatternResponse>
Get an event pattern by name
Retrieve event pattern details by event name for a workflow event trigger. Event names are case-sensitive, so PaymentReceived and paymentReceived are different events.
- Path:
GET /v1/event-patterns/by-name/{eventName}
Sourcepub async fn get_event_pattern(
&self,
request: GetEventPatternRequest,
) -> Result<GetEventPatternResponse>
pub async fn get_event_pattern( &self, request: GetEventPatternRequest, ) -> Result<GetEventPatternResponse>
Get an event pattern by ID
Retrieve event pattern details for a workflow event trigger.
- Path:
GET /v1/event-patterns/{eventPatternId}
Sourcepub async fn list_mailing_lists(
&self,
request: ListMailingListsRequest,
) -> Result<ListMailingListsResponse>
pub async fn list_mailing_lists( &self, request: ListMailingListsRequest, ) -> Result<ListMailingListsResponse>
List mailing lists
Retrieve a list of your account’s mailing lists.
- Path:
GET /v1/lists
Sourcepub async fn get_theme(
&self,
request: GetThemeRequest,
) -> Result<GetThemeResponse>
pub async fn get_theme( &self, request: GetThemeRequest, ) -> Result<GetThemeResponse>
Get a theme
Retrieve a single theme by ID.
- Path:
GET /v1/themes/{themeId}
Sourcepub async fn update_theme(
&self,
request: UpdateThemeRequest,
) -> Result<UpdateThemeResponseEnum>
pub async fn update_theme( &self, request: UpdateThemeRequest, ) -> Result<UpdateThemeResponseEnum>
Update a theme
Update a theme’s name and/or styles. When styles change, the update cascades to every email using this theme, and affectedEmailCount in the response reports how many emails were affected. Manual style edits made on individual emails are preserved: the cascade only changes properties an email has not overridden. A per-email override is removed only when it becomes identical to the theme’s new value, after which that email follows the theme for that property.
- Path:
POST /v1/themes/{themeId}
Sourcepub async fn list_themes(
&self,
request: ListThemesRequest,
) -> Result<ListThemesResponseEnum>
pub async fn list_themes( &self, request: ListThemesRequest, ) -> Result<ListThemesResponseEnum>
List themes
Retrieve a paginated list of email themes, most recently created first.
- Path:
GET /v1/themes
Sourcepub async fn create_theme(
&self,
request: CreateThemeRequest,
) -> Result<CreateThemeResponse>
pub async fn create_theme( &self, request: CreateThemeRequest, ) -> Result<CreateThemeResponse>
Create a theme
Create a new email theme for use across Loops emails.
- Path:
POST /v1/themes
Sourcepub async fn list_published_transactional_emails(
&self,
request: ListPublishedTransactionalEmailsRequest,
) -> Result<ListPublishedTransactionalEmailsResponse>
pub async fn list_published_transactional_emails( &self, request: ListPublishedTransactionalEmailsRequest, ) -> Result<ListPublishedTransactionalEmailsResponse>
List transactional emails (legacy)
Get a list of published transactional emails.
- Path:
GET /v1/transactional
Sourcepub async fn send_transactional_email(
&self,
request: SendTransactionalEmailRequest,
) -> Result<SendTransactionalEmailResponse>
pub async fn send_transactional_email( &self, request: SendTransactionalEmailRequest, ) -> Result<SendTransactionalEmailResponse>
Send a transactional email
Send a transactional email to a contact.
Please email us to enable attachments on your account before using them with the API.
To set dynamic Subject, From, Reply to, CC, BCC email header fields, add data variables to those fields in the editor, then include data for each variable in the API request. Read our transactional email guide for more details.
- Path:
POST /v1/transactional
Sourcepub async fn list_transactional_emails(
&self,
request: ListTransactionalEmailsRequest,
) -> Result<ListTransactionalEmailsResponse>
pub async fn list_transactional_emails( &self, request: ListTransactionalEmailsRequest, ) -> Result<ListTransactionalEmailsResponse>
List transactional emails
Retrieve a paginated list of transactional emails, most recently created first.
- Path:
GET /v1/transactional-emails
Sourcepub async fn create_transactional_email(
&self,
request: CreateTransactionalEmailRequest,
) -> Result<CreateTransactionalEmailResponse>
pub async fn create_transactional_email( &self, request: CreateTransactionalEmailRequest, ) -> Result<CreateTransactionalEmailResponse>
Create a transactional email
Create a new transactional email. An empty draft email message is created automatically and its draftEmailMessageId is returned. Use the POST /v1/email-messages/{emailMessageId} endpoint along with the returned draftEmailMessageContentRevisionId to set subject, sender, preview text, and LMX content, then call POST /v1/transactional-emails/{transactionalId}/publish to publish the draft.
- Path:
POST /v1/transactional-emails
Sourcepub async fn get_transactional_email(
&self,
request: GetTransactionalEmailRequest,
) -> Result<GetTransactionalEmailResponse>
pub async fn get_transactional_email( &self, request: GetTransactionalEmailRequest, ) -> Result<GetTransactionalEmailResponse>
Get a transactional email
Retrieve a single transactional email by ID.
- Path:
GET /v1/transactional-emails/{transactionalId}
Sourcepub async fn update_transactional_email(
&self,
request: UpdateTransactionalEmailRequest,
) -> Result<GetTransactionalEmailResponse>
pub async fn update_transactional_email( &self, request: UpdateTransactionalEmailRequest, ) -> Result<GetTransactionalEmailResponse>
Update a transactional email
Update a transactional email’s name or group. At least one field must be provided.
- Path:
POST /v1/transactional-emails/{transactionalId}
Sourcepub async fn get_transactional_email_metrics(
&self,
request: GetTransactionalEmailMetricsRequest,
) -> Result<GetTransactionalEmailMetricsResponse>
pub async fn get_transactional_email_metrics( &self, request: GetTransactionalEmailMetricsRequest, ) -> Result<GetTransactionalEmailMetricsResponse>
Get transactional email metrics
Retrieve all-time delivery metrics for a transactional email, totalled across every published version.
- Path:
GET /v1/transactional-emails/{transactionalId}/metrics
Sourcepub async fn ensure_transactional_draft(
&self,
request: EnsureTransactionalDraftRequest,
) -> Result<EnsureTransactionalDraftResponse>
pub async fn ensure_transactional_draft( &self, request: EnsureTransactionalDraftRequest, ) -> Result<EnsureTransactionalDraftResponse>
Ensure a draft email message
Ensure the transactional email has a draft email message. If a draft already exists it is returned unchanged; otherwise a new empty draft is created (seeded from the most recent published version when present). Use POST /v1/email-messages/{emailMessageId} to edit the draft’s content.
- Path:
POST /v1/transactional-emails/{transactionalId}/draft
Sourcepub async fn publish_transactional_email(
&self,
request: PublishTransactionalEmailRequest,
) -> Result<PublishTransactionalEmailResponse>
pub async fn publish_transactional_email( &self, request: PublishTransactionalEmailRequest, ) -> Result<PublishTransactionalEmailResponse>
Publish a transactional email draft
Publish the transactional email’s current draft email message. The draft becomes the published version and the draft is cleared.
- Path:
POST /v1/transactional-emails/{transactionalId}/publish
Sourcepub async fn list_transactional_groups(
&self,
request: ListTransactionalGroupsRequest,
) -> Result<ListCampaignGroupsResponse>
pub async fn list_transactional_groups( &self, request: ListTransactionalGroupsRequest, ) -> Result<ListCampaignGroupsResponse>
List transactional groups
Retrieve a paginated list of transactional groups, most recently created first.
- Path:
GET /v1/transactional-groups
Sourcepub async fn create_transactional_group(
&self,
request: CreateTransactionalGroupRequest,
) -> Result<CreateCampaignGroupResponse>
pub async fn create_transactional_group( &self, request: CreateTransactionalGroupRequest, ) -> Result<CreateCampaignGroupResponse>
Create a transactional group
Create a new transactional group.
- Path:
POST /v1/transactional-groups
Sourcepub async fn get_transactional_group(
&self,
request: GetTransactionalGroupRequest,
) -> Result<GetCampaignGroupResponse>
pub async fn get_transactional_group( &self, request: GetTransactionalGroupRequest, ) -> Result<GetCampaignGroupResponse>
Get a transactional group
Retrieve a single transactional group by ID.
- Path:
GET /v1/transactional-groups/{transactionalGroupId}
Sourcepub async fn update_transactional_group(
&self,
request: UpdateTransactionalGroupRequest,
) -> Result<GetCampaignGroupResponse>
pub async fn update_transactional_group( &self, request: UpdateTransactionalGroupRequest, ) -> Result<GetCampaignGroupResponse>
Update a transactional group
Update a transactional group’s name or description. At least one field must be provided. The reserved “Unsorted” group cannot be edited.
- Path:
POST /v1/transactional-groups/{transactionalGroupId}
Sourcepub async fn create_upload(
&self,
request: CreateUploadRequestParams,
) -> Result<CreateUploadResponseEnum>
pub async fn create_upload( &self, request: CreateUploadRequestParams, ) -> Result<CreateUploadResponseEnum>
Create an upload
Request a pre-signed URL to upload an image asset. Upload the file with an HTTP PUT to the returned presignedUrl (sending the same Content-Type and Content-Length), then call /uploads/{emailAssetId}/complete to finalize the asset.
- Path:
POST /v1/uploads
Sourcepub async fn complete_upload(
&self,
request: CompleteUploadRequest,
) -> Result<CompleteUploadResponseEnum>
pub async fn complete_upload( &self, request: CompleteUploadRequest, ) -> Result<CompleteUploadResponseEnum>
Complete an upload
Finalize an image upload after the file has been uploaded to the pre-signed URL. Returns the public URL of the uploaded image asset.
- Path:
POST /v1/uploads/{emailAssetId}/complete
Sourcepub async fn list_workflow_groups(
&self,
request: ListWorkflowGroupsRequest,
) -> Result<ListCampaignGroupsResponse>
pub async fn list_workflow_groups( &self, request: ListWorkflowGroupsRequest, ) -> Result<ListCampaignGroupsResponse>
List workflow groups
Retrieve a paginated list of workflow groups, most recently created first.
- Path:
GET /v1/workflow-groups
Sourcepub async fn create_workflow_group(
&self,
request: CreateWorkflowGroupRequest,
) -> Result<CreateCampaignGroupResponse>
pub async fn create_workflow_group( &self, request: CreateWorkflowGroupRequest, ) -> Result<CreateCampaignGroupResponse>
Create a workflow group
Create a new workflow group.
- Path:
POST /v1/workflow-groups
Sourcepub async fn get_workflow_group(
&self,
request: GetWorkflowGroupRequest,
) -> Result<GetCampaignGroupResponse>
pub async fn get_workflow_group( &self, request: GetWorkflowGroupRequest, ) -> Result<GetCampaignGroupResponse>
Get a workflow group
Retrieve a single workflow group by ID.
- Path:
GET /v1/workflow-groups/{workflowGroupId}
Sourcepub async fn update_workflow_group(
&self,
request: UpdateWorkflowGroupRequest,
) -> Result<GetCampaignGroupResponse>
pub async fn update_workflow_group( &self, request: UpdateWorkflowGroupRequest, ) -> Result<GetCampaignGroupResponse>
Update a workflow group
Update a workflow group’s name or description. At least one field must be provided. The reserved “Unsorted” group cannot be edited.
- Path:
POST /v1/workflow-groups/{workflowGroupId}
Sourcepub async fn list_workflows(
&self,
request: ListWorkflowsRequest,
) -> Result<ListWorkflowsResponseEnum>
pub async fn list_workflows( &self, request: ListWorkflowsRequest, ) -> Result<ListWorkflowsResponseEnum>
List workflows
Retrieve a paginated list of workflows.
- Path:
GET /v1/workflows
Sourcepub async fn create_workflow(
&self,
request: CreateWorkflowRequestParams,
) -> Result<CreateWorkflowResponse>
pub async fn create_workflow( &self, request: CreateWorkflowRequestParams, ) -> Result<CreateWorkflowResponse>
Create a workflow
Create a draft workflow with a blank trigger and exit node. When workflowGroupId is omitted, the workflow is added to the team’s Unsorted group.
- Path:
POST /v1/workflows
Sourcepub async fn get_workflow(
&self,
request: GetWorkflowRequest,
) -> Result<GetWorkflowResponse>
pub async fn get_workflow( &self, request: GetWorkflowRequest, ) -> Result<GetWorkflowResponse>
Get a workflow
Retrieve a workflow graph with node type names, connections, and selected display fields.
- Path:
GET /v1/workflows/{workflowId}
Sourcepub async fn update_workflow_properties(
&self,
request: UpdateWorkflowPropertiesRequestParams,
) -> Result<UpdateWorkflowPropertiesResponse>
pub async fn update_workflow_properties( &self, request: UpdateWorkflowPropertiesRequestParams, ) -> Result<UpdateWorkflowPropertiesResponse>
Update a workflow
Update a workflow’s name, description, or group. At least one field must be provided. To change the workflow’s mailing list, use the POST /v1/workflows/{workflowId}/mailing-list endpoint instead.
- Path:
POST /v1/workflows/{workflowId}
Sourcepub async fn delete_workflow(
&self,
request: DeleteWorkflowRequestParams,
) -> Result<DeleteWorkflowResponse>
pub async fn delete_workflow( &self, request: DeleteWorkflowRequestParams, ) -> Result<DeleteWorkflowResponse>
Delete a workflow
Delete a workflow. Successful deletion returns 204 No Content. If the workflow is currently sending or has queued contacts, Loops returns 409 Conflict with a message instead of deleting. Retry with confirmDelete: true to delete the workflow, stop sending, and cancel queued contacts.
- Path:
DELETE /v1/workflows/{workflowId}
Sourcepub async fn change_workflow_mailing_list(
&self,
request: ChangeWorkflowMailingListRequestParams,
) -> Result<ChangeWorkflowMailingListResponseEnum>
pub async fn change_workflow_mailing_list( &self, request: ChangeWorkflowMailingListRequestParams, ) -> Result<ChangeWorkflowMailingListResponseEnum>
Change workflow mailing list
Dry run or apply a workflow mailing list change. If queued contacts would be removed from the workflow due to the change of mailing list, Loops returns with "status": "queuedContactsFound" instead of applying the change. Retry with queuedContactPolicy: "discard" to apply the change and discard those contacts. Confirmed update responses include the simplified workflow after the mailing list changes.
- Path:
POST /v1/workflows/{workflowId}/mailing-list
Sourcepub async fn create_workflow_node(
&self,
request: CreateWorkflowNodeRequestParams,
) -> Result<CreateWorkflowNodeResponseEnum>
pub async fn create_workflow_node( &self, request: CreateWorkflowNodeRequestParams, ) -> Result<CreateWorkflowNodeResponseEnum>
Create a workflow node
Create a new default workflow node and return it with the latest workflow.
Choose where the node goes with insertMode: between places it between an existing fromNodeId -> toNodeId connection, before places it before toNodeId, and after places it after fromNodeId when that node has exactly one outgoing connection. after is a convenience for simple linear paths, so callers do not need to fetch and pass the current child node ID. It is invalid when fromNodeId has no outgoing nodes, multiple outgoing nodes, or is an exit node. When the source has multiple outgoing nodes, use between with the exact toNodeId instead. For before, deprecated beforeNodeId requests are still accepted for compatibility, but new callers should use toNodeId.
New nodes start with default settings; update the node after creation to configure it. Branch nodes create their default paths too: BranchNode creates two AudienceFilter children, and ExperimentBranchNode creates two regular VariantNode children plus one control VariantNode. Public workflows can have up to 400 nodes. Generated children count toward that limit, so a normal create adds 1 node, BranchNode adds 3, and ExperimentBranchNode adds 4. To add a sibling child path to a branch or experiment branch, use the POST /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch endpoint. Branch paths can be edited with create-node, but a workflow cannot be started unless each direct BranchNode child is an AudienceFilter. For experiments, use create-node only to insert a missing VariantNode before non-variant content; use add-branch for another variant path.
- Path:
POST /v1/workflows/{workflowId}/nodes
Sourcepub async fn add_workflow_branch(
&self,
request: AddWorkflowBranchRequestParams,
) -> Result<AddWorkflowBranchResponseEnum>
pub async fn add_workflow_branch( &self, request: AddWorkflowBranchRequestParams, ) -> Result<AddWorkflowBranchResponseEnum>
Add a branch
Add a branch and a child node under an existing Branch or Experiment node. Returns the created child node plus the latest workflow.
- Adding a branch to a
BranchNodecreates oneAudienceFilterchild node. - Adding a branch to an
ExperimentBranchNodecreates oneVariantNodechild node.
This endpoint does not accept node configuration fields; update the child node with POST /v1/workflows/{workflowId}/nodes/{nodeId} after creation. Public workflows are limited to 400 nodes, and this endpoint adds 1 node.
- Path:
POST /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch
Sourcepub async fn get_workflow_node(
&self,
request: GetWorkflowNodeRequest,
) -> Result<GetWorkflowNodeResponse>
pub async fn get_workflow_node( &self, request: GetWorkflowNodeRequest, ) -> Result<GetWorkflowNodeResponse>
Get a workflow node
Retrieve detailed data for a single workflow node.
- Path:
GET /v1/workflows/{workflowId}/nodes/{nodeId}
Sourcepub async fn update_workflow_node(
&self,
request: UpdateWorkflowNodeRequestParams,
) -> Result<UpdateWorkflowNodeResponseEnum>
pub async fn update_workflow_node( &self, request: UpdateWorkflowNodeRequestParams, ) -> Result<UpdateWorkflowNodeResponseEnum>
Update a workflow node
Update workflow-node-owned fields for a single node. Shared resources such as email messages and audience segments should be updated through their own APIs.
- Path:
POST /v1/workflows/{workflowId}/nodes/{nodeId}
Sourcepub async fn delete_workflow_node(
&self,
request: DeleteWorkflowNodeRequestParams,
) -> Result<DeleteWorkflowNodeResponseEnum>
pub async fn delete_workflow_node( &self, request: DeleteWorkflowNodeRequestParams, ) -> Result<DeleteWorkflowNodeResponseEnum>
Delete a workflow node
Delete a single workflow node. If contacts are queued at the node, Loops returns with "status": "queuedContactsFound" instead of deleting. Retry with queuedContactPolicy: "discard" to delete the node and discard those queued contacts. Confirmed deletion responses include the simplified workflow after the node is removed.
- Path:
DELETE /v1/workflows/{workflowId}/nodes/{nodeId}
Sourcepub async fn get_workflow_node_metrics(
&self,
request: GetWorkflowNodeMetricsRequest,
) -> Result<GetWorkflowNodeMetricsResponse>
pub async fn get_workflow_node_metrics( &self, request: GetWorkflowNodeMetricsRequest, ) -> Result<GetWorkflowNodeMetricsResponse>
Get workflow node metrics
Retrieve all-time email engagement metrics for a workflow SendEmailAction node. Nodes of any other type return a 400 response. A SendEmailAction node with an email that has not sent anything yet reports every counter as 0.
- Path:
GET /v1/workflows/{workflowId}/nodes/{nodeId}/metrics
Sourcepub async fn reroute_node_connection(
&self,
request: RerouteNodeConnectionRequestParams,
) -> Result<RerouteNodeConnectionResponseEnum>
pub async fn reroute_node_connection( &self, request: RerouteNodeConnectionRequestParams, ) -> Result<RerouteNodeConnectionResponseEnum>
Reroute a node connection
Reroute the source node’s existing connection to another valid target node. Returns the updated source node and the latest workflow.
- Path:
POST /v1/workflows/{workflowId}/nodes/{nodeId}/reroute
Sourcepub async fn delete_workflow_node_recursively(
&self,
request: DeleteWorkflowNodeRecursivelyRequest,
) -> Result<DeleteWorkflowNodeResponseEnum>
pub async fn delete_workflow_node_recursively( &self, request: DeleteWorkflowNodeRecursivelyRequest, ) -> Result<DeleteWorkflowNodeResponseEnum>
Delete workflow nodes recursively
Delete a node and its downstream subtree. If contacts are queued at any node that would be deleted, Loops returns with "status": "queuedContactsFound" instead of deleting. Retry with queuedContactPolicy: "discard" to delete the nodes and discard those queued contacts. Confirmed deletion responses include the simplified workflow after the nodes are removed.
- Path:
DELETE /v1/workflows/{workflowId}/nodes/{nodeId}/recursive