Mindbaz API (V1)

To select the subscribers to be exported, you will need a target. This target can be created in the mail applilcation or by api.
📝 The default output file is an ANSI encoded csv file with ";" as column separator and CRLF windows newline character. Field names are used for column headers.
📝 The execution of the export is asynchronous, so you won't know right away if the export is successful. But in case of error, you will receive en email "Error concerning the export...".
At the end of the export, you will also receive an email with the subject starting with "Export of the file..."
⚠️ Be careful, if you run too many exports at the same time, you'll get this error : "Error, too many exports in progress (max 10)". For performance reasons, we don't allow more than 10 simultaneous exports per database. 💡 You can call this endpoint to get the execution status of your export you just created.

If you don't want to use mindbaz sftp account as export output, you can ask customer service to add your own sftp account to mindbaz. You can get your SFTP account ID with this endpoint and use it in the Post Method (IdRepository parameter) to create an new export job.

the result is the same as the field management page. It is an array of Field object.

This corresponds to the number of fields whose ID is greater than 100.
⚠️ The maximum number of fields you can create is by default 50

If the field id does not exist, a null object is returned. Otherwise, the updated field object is returned. ⚠️ You can't modify a system field (id < 100) !
📝 You can change only the parameter you want to update. But if you want to change the fieldType to "List", you must provide a "List" value too.
And if you want to change the fieldType to "Text", you must provide a "Length" value too.
⚠️ Beware, if you change the field type, the field values will be emptied!
⚠️ Please do not call this method too often. The processing to modify a field type can be long, especially if the subscribers table is large! In addition, it is not recommended to modify the type of a field if a sending or import is in progress.

The new field id is created automaticaly (with the max ID + 1). So you don't to pass the id to the Post method.
On the other hand, the mandatory parameters are the Name and the FieldType
And if you create a new "List" field, you must provide a "List" value too.
And if you create a new "Text" field, you must provide a "Length" value too.
💡 It is recommended to choose a unique name (but not required).

The newly created field object is returned by the post method.

Counts the number of subscribers in the database

For example,

• To get subscribers with idSub=[1,2,3,25,47], the query parameters will be: filter.by=IdSubscriber&filter.values[0]=1&filter.values[1]=2&filter.values[2]=3&filter.values[3]=25&filter.values[4]=47
• To search for a subscriber MD5 and return fields [0,1,7,14,15], the query parameters will be: filter.by=Email&filter.idFields[0]=1&filter.idFields[1]=7&filter.idFields[2]=14&filter.idFields[3]=15&filter.emailEncoding=MD5&filter.values[0]=B9F77479156D2E90AFB3C43151ACA814

The method returns an array of Subscriber object. If the subscriber is not found, a null object is returned.

The method returns an array of the updated subscribers. If the subscriber was not found, a null object is retured in the array.
Here is an example of a body schema to update 2 fields (field[7] and field[4]) to unsubscribe 2 users with field[0] in (1234,1235):

[
    {
    "id" : 1234,
    "fields" : [   { "idField": 7, "value":1 },
                   { "idField": 4, "value": "2023/10/04 17:39"} ]
    },
    { 
    "id" : 1235,
    "fields" : [ { "idField": 7, "value":1 },
                { "idField": 4, "value": "2023/10/04 18:39" }]
    }
]

The method returns an array of the inserted subscribers.

• If you do not provide an Id, the method is doing an INSERT. You can't insert a duplicate email. The inserted subscriber is retured in the result array.
• If you provide an Id, the method will try to do an UPDATE.
  - If the Id does not exist, the update does nothing. A null subscriber object is returned in the array.
  - If the Id exist, its fields are updated and are returned in the result array.

Here is a simple example of a body schema to insert a new email subscriber (field[1]):

[
    {    
    "fields" : [ { "idField": 1, "value":"test@mindbaz.com" } ]
    }
]

The POST method will return a Subscriber Array Object like this (with the new generated Subscriber Ids) :

[
    {    
    "id" : 4060006,
    "fields" : [    { "idField": 0, "value":4060006 },
                    { "idField": 1, "value":"test@mindbaz.com" },
                    { "idField": 2, "value":"2023-10-09T10:32:06.0585536+02:00" },
                    { "idField": 3, "value":"2023-10-09T10:32:06.0585536+02:00" },
                    { "idField": 37, "value":"mindbaz.com" }
                ]
    }
]

📝 The email is the only mandatory field for a subscriber creation. If you don't provide the email, you will get this error "Error, email to insert not found".
📝 You'll notice that the dates of the first and last subscriptions (fieldIds 2 and 3) are automatically set to Now Datetime. And a new inserted email is always created with a subscribed state (field[7]=0)
⚠️ Attention, if you try to repost this email a 2nd time, you will get an error: "An error occurred: Cannot insert a duplicate subscriber because his email already exists in the database.".
⚠️ And If an error occurs in the middle of the array, processing is interrupted and subsequent emails are not processed.

Here is a example of a body schema to insert a new email subscriber and 2 updates (including a non-existent id):

[
    {
    "fields" : [ { "idField": 1, "value":"test2@mindbaz.com" } ]
    },
    {
    "id" : 4060007, /* non existent id */
    "fields" : [   { "idField": 14, "value":"my Last Name"},
                   { "idField": 15, "value":"my First Name" } ]
    },
    {
    "id" : 4060006,
    "fields" : [   { "idField": 14, "value":"my Last Name2"},
                   { "idField": 15, "value":"my First Name2" } ]
    }
]

The POST method will return :

[
     {    
    "id" : 4060017,
    "fields" : [  { "idField": 0, "value":4060017 },
                    { "idField": 1, "value":"test2@mindbaz.com" },
                    { "idField": 2, "value":"2023-10-09T11:33:06.0585536+02:00" },
                    { "idField": 3, "value":"2023-10-09T11:33:06.0585536+02:00" },
                    { "idField": 37, "value":"mindbaz.com" }
                ]
    },
    null,
    {    
    "id" : 4060006,
    "fields" : [  { "idField": 0, "value":4060006 },
                    { "idField": 14, "value":"my Last Name2" },
                    { "idField": 15, "value":"my First Name2" }                    
                ]
    }
]

This method will remove subscribers from the database and returns the deleted IDs. If the identifier is not found, it will not be present in the result Array.
⚠️ Do not use this method to delete all your subscribers! It won't be effective! If you want to delete millions of rows, you can ask customer service.

You can use this method to query if an email belongs to the archive table.
The operation is the same as Subscribers Get Method.

This method is useful to unsubscribe your subscribers.
📝 You can unsubscribe in 3 ways:

• from the global newsletter :
  
  • subscriber_status = optin (field[7]=1)
    
  • unsubscription_date = Now (field[4]=Now)
    
• from partner offers:
  
  • Partner offers opt-in = Yes (field[8]=1)
    
  • Partner offers opt-in date = Now (field[10]=Now)
    
• from a specific newsletter
  
  • field[IdSubscriptionField] = 1
    
  • field[IdUnsubDateField] = Now
    
    

💡 This method should be use to manage your unsubscriptions because it updates the unsubscription statistics of your campaigns. To do this, you must enter the IdSent parameter which you can retrieve using the config tag [[CONF.7]]

This method is useful for subscribing or resubscribing an email that has already been subscribed to in the past. Thus the origin of the collect (stored in the date of first subscription and first origin fields) is not overwritten.
📝 This method updates the following fields :

• field[7]=0 (subscriber_status=optin)
  
• field[3]=Date (last subscription date)
  
• field[6]=LastOrigin (last provenance)
  
• if SubscribeToPartnersOffers=True, field[8]=1 (Partner offers opt-in = Yes)
  
• if SubscribeToPartnersOffers=True, field[10]=Date (partners offers optin date)
  
  

The method returns a boolean array indicating if update has been done for each subscriber id.

This method is useful to subscribe a new inserted email addresses with its origin information (stored in the date of first subscription and first origin fields) .
📝 This method updates the following fields :

• field[7]=0 (subscriber_status=optin)
  
• field[2]=field[3]=Date (first & last subscription dates)
  
• field[5]=field[6]=FirstOrigin (first and last provenance)
  
• field[21]=collectMode
• field[22]= collectType
• if SubscribeToPartnersOffers = True, field[8]=1 (Partner offers opt-in = Yes)
  
• if SubscribeToPartnersOffers = True, field[10]=Date (partners offers optin date)
  
  

The method returns a boolean array indicating if update has been done for each subscriber id.