Request SMS Recipient Export

Export an SMS campaign's recipients

It returns the background process ID which on completion calls the notify URL that you have set in the input.

Options

Campaign Id
id of the campaign
Body (*)
Values to send for a recipient export request

Request body which must comply to the following JSON Schema:

{
  "required" : [ "recipientsType" ],
  "type" : "object",
  "properties" : {
    "notifyURL" : {
      "type" : "string",
      "description" : "URL that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479",
      "format" : "url",
      "example" : "http://requestb.in/173lyyx1"
    },
    "recipientsType" : {
      "type" : "string",
      "description" : "Filter the recipients based on how they interacted with the campaign",
      "example" : "answered",
      "enum" : [ "all", "delivered", "answered", "softBounces", "hardBounces", "unsubscribed" ]
    }
  }
}
Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

  • status: HTTP status code

Input Ports

Icon
Configuration data.

Output Ports

Icon
Result of the request depending on the selected Result Format.
Icon
Configuration data (this is the same as the input port; it is provided as passthrough for sequentially chaining nodes to declutter your workflow connections).

Popular Predecessors

  • No recommendations found

Popular Successors

  • No recommendations found

Views

This node has no views

Workflows

  • No workflows found

Links

Developers

You want to see the source code for this node? Click the following button and we’ll use our super-powers to find it for you.