POST /contacts/export
It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.
Servers
- https://api.sendinblue.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
skipFilesMerge |
Boolean | No |
To stop merging the file into single file Default value: false |
exportDateInUTC |
Boolean | No |
Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format. Default value: false |
notifyUrl |
String | No |
Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 |
exportMetadata[] |
Array | No |
Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME. Alias support is also available for ADDED_TIME & MODIFIED_TIME, allowing to use expressions like ADDED_TIME AS _ADDED_TIME. |
customContactFilter |
Object | No |
Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. |
customContactFilter.emailCampaignId |
Integer | No |
Considered only if actionForEmailCampaigns is passed, ignored otherwise. Mandatory if action is one of the following - openers, nonOpeners, clickers, nonClickers, unsubscribed. The id of the email campaign for which the corresponding action shall be applied in the filter. |
customContactFilter.actionForEmailCampaigns |
String | No |
Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email campaigns. * openers & nonOpeners - emailCampaignId is mandatory. Fetch the list of readers / non-readers for a particular email campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch the list of clickers / non-clickers for a particular email campaign. * unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed (blacklisted via any means) contacts for a particular email campaign. * hardBounces & softBounces - emailCampaignId is optional. Fetch the list of hard bounces / soft bounces for a particular / all email campaign(s). Valid values:
|
customContactFilter.smsCampaignId |
Integer | No |
Considered only if actionForSmsCampaigns is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. |
customContactFilter.listId |
Integer | No |
ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included. |
customContactFilter.actionForSmsCampaigns |
String | No |
Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed (blacklisted via any means) contacts for all / particular sms campaigns. * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces for all / particular sms campaigns. Valid values:
|
customContactFilter.segmentId |
Integer | No |
ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included. |
customContactFilter.actionForContacts |
String | No |
Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on contacts as per the list id. * allContacts - Fetch the list of all contacts for a particular list. * subscribed & unsubscribed - Fetch the list of subscribed / unsubscribed (blacklisted via any means) contacts for a particular list. * unsubscribedPerList - Fetch the list of contacts that are unsubscribed from a particular list only. Valid values:
|
customContactFilter.importProcessId |
Integer | No |
Mandatory if actionForContacts is passed, ignored otherwise. import process Id of the process for which the corresponding action shall be applied in the filter. |
disableNotification |
Boolean | No |
To disable email notification Default value: false |
exportSubscriptionStatus[] |
Array | No |
Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact. |
exportAttributes[] |
Array | No |
List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email', 'CONTACT ID']. |
disableFrontendNotification |
Boolean | No |
To disable frontend notification Default value: false |
contactFilter |
Object | No |
This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {"blacklisted":true} will export all the blacklisted contacts. |
exportMandatoryAttributes |
Boolean | No |
To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME Default value: true |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.