# sib_contacts.requestcontactexport: Sendinblue Package for Contacts operations that could not be mapped to a table. sib_contacts.requestcontactexport: Sendinblue Package for Contacts operations that could not be mapped to a table. 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.Parameters of Procedure The following parameters can be used to control the behaviour of the procedure `sib_contacts.requestcontactexport`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `begin package.procedure(value1, value2, value3); end` on a procedure with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `begin package.procedure(name1 => value1, name3 => value3); end` on the same procedure will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `actionForContacts` | `string` | ☐ | | **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. | | `actionForEmailCampaigns` | `string` | ☐ | | **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). | | `actionForSmsCampaigns` | `string` | ☐ | | **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. | | `emailCampaignId` | `int64` | ☐ | | 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. | | `listId` | `int64` | ☐ | | ID of the list. This is mandatory if actionForContacts is specified and segmentId is not provided. Either segmentId or listId must be included. | | `segmentId` | `int64` | ☐ | | ID of the segment. This is mandatory if actionForContacts is specified and listId is not provided. Either segmentId or listId must be included. | | `smsCampaignId` | `int64` | ☐ | | Considered only if **actionForSmsCampaigns** is passed, ignored otherwise. The id of sms campaign for which the corresponding action shall be applied in the filter. | | `disableNotification` | `boolean` | ☐ | False | To avoid generating the email notification upon contact export, pass **true** | | `exportMandatoryAttributes` | `boolean` | ☐ | True | To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME | | `exportDateInUTC` | `boolean` | ☐ | False | Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format. | | `notifyUrl` | `string` | ☐ | | Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479 |