Knowledgebase

Creating a recipient in a group

Exammple of json data for HTTP request:

{
  "email":"alice@example.org",
  "unconfirmed": true,
  "values":[
    {
      "parameter_id":"1",
      "value":"Alice"
    },
    {
      "parameter_id":"2",
      "value":"22"
    }
  ]
}

Example of an HTTP request:

curl -X POST https://api.msndr.net/v1/email/lists/1/recipients \
     -H 'Content-Type: application/json'                       \
     -H 'Authorization: Bearer $API_TOKEN'                     \
     -d '...JSON...'

It uses the POST method and a link /email/lists/:id/recipients

where id is the recipient group identifier

Example response for a successful HTTP request:

{
  "id":1,
  "email":"alice@example.org",
  "confirmed":false,
  "list_id":1,
  "status": "active",
  "values":[
    {
      "value":"Alice",
      "kind":"string",
      "parameter_id":1
    },
    {
      "value":22.0,
      "kind":"numeric",
      "parameter_id":2
    }
  ]
}

The request parameters:

The parameters of the elements of the values and their description:

The description of the attributes of the json response from the server:

Explanation of the attributes of the elements of the values array in the json response of the server:

Getting information about a recipient in a group

HTTP request example:

curl -X GET https://api.msndr.net/v1/email/lists/1/recipients/2 \
     -H 'Content-Type: application/json'                   \
     -H 'Authorization: Bearer $API_TOKEN'

Here the GET method is used and the link /email/lists/:list_id/recipients/:id

where list_id is the recipient group identifier, and id is the recipient's id

An example of a response in case of a successful request:

{
  "id":2,
  "email":"alice@example.org",
  "confirmed":false,
  "list_id":1,
  "status": "active",
  "values":[
    {
      "value":"Alice",
      "kind":"string",
      "parameter_id":1
    },
    {
      "value":22.0,
      "kind":"numeric",
      "parameter_id":2
    }
  ]
}
 

The table below explains the HTTP request parameters:

server response json attributes:

Explanation of the attributes of the elements of the values array in the json response of the server:

Editing recipient parameters in a group:

Example of json data for HTTP request:

{
  "email":"alice@example.org",
  "values":[
    {
      "parameter_id":"1",
      "value":"Alice"
    },
    {
      "parameter_id":"2",
      "destroy":"true"
    }
  ]
}

Example of an HTTP request:

curl -X PATCH https://api.msndr.net/v1/email/lists/1/recipients/1 \
     -H 'Content-Type: application/json'                     \
     -H 'Authorization: Bearer $API_TOKEN'                   \
     -d '...JSON...'

The PATCH method is used and the link /email/lists/:list_id/recipients/:id

where list_id is the recipient group identifier, id is the recipient identifier

An example of a response in case of a successful request:

{
  "id":1,
  "email":"alice@example.org",
  "confirmed":true,
  "status": "active",
  "list_id":1,
  "values":[
    {
      "value":"Alice",
      "kind":"string",
      "parameter_id":1
    }
  ]
}

An explanation of the request parameters:

Parameters of an element of the values array in an HTTP request

attributes in the json response from the server:

parameters of elements of the values array in the json response of the server:

Getting the list of recipients in a group

HTTP request example:

curl -X GET https://api.msndr.net/v1/email/lists/1/recipients \
     -H 'Content-Type: application/json'                 \
     -H 'Authorization: Bearer $API_TOKEN'

Here we use the GET method and the link /email/lists/:id/recipients

Where id is the id of the recipient group

This method supports paginated output. The maximum page size is 1000

Example json response in case of successful request:

{
  "total_count":2,
  "total_pages":1,
  "page_number":1,
  "page_size":25,
  "collection":[
    {
      "id":1,
      "email":"alice@example.org",
      "confirmed":true,
      "status": "active",
      "list_id":1,
      "values":[
        {
          "value":"Alice",
          "kind":"string",
          "parameter_id":9
        },
        {
          "value":22.0,
          "kind":"numeric",
          "parameter_id":10
        }
      ]
    },
    {
      "id":2,
      "email":"bob@example.org",
      "confirmed":true,
      "status": "active",
      "list_id":1,
      "values":[
      ]
    }
  ]
}

Parameters of elements of recipient array (collection) of json response from server :

parameters of the elements of the values array for each recipient:

Deleting a recipient in a group

HTTP request example:

curl -X DELETE https://api.msndr.net/v1/email/lists/1/recipients/1 \
     -H 'Content-Type: application/json'                      \
     -H 'Authorization: Bearer $API_TOKEN'
 

DELETE method and the /email/lists/:list_id/recipients/:id link are used

Where list_id is the recipient group id, id is the recipient id.

Importing a large number of recipients into a recipient group

Example of json data for HTTP request:

{
  "recipients":[
    {
      "email":"alice@example.org",
      "values":[
        {
          "parameter_id":"1",
          "value":"Alice"
        },
        {
          "parameter_id":"2",
          "value":"22"
        }
      ]
    },
    {
      "email":"bob@example.org",
      "values":[
        {
          "parameter_id":"1",
          "value":"Bob"
        },
        {
          "parameter_id":"2",
          "value":"11"
        }
      ]
    }
  ]
}

HTTP request example:

curl -X POST https://api.msndr.net/v1/email/lists/1/recipients/imports \
     -H 'Content-Type: application/json'                       \
     -H 'Authorization: Bearer $API_TOKEN'                     \
     -d '...JSON...'

POST method and link /email/lists/:id/recipients/imports is used

Where id is the id of the recipient group

Example of json response in case of successful request:

{
  "id":7,
  "status":"queued"
}

The parameters in the HTTP request json data

Description of the parameters of the recipient array elements (recipients) to be imported:

Description of the parameters of the elements of the values array for each recipient:

Server response json parameters:

Recipient search by email address

HTTP request example:

curl -X GET https://api.msndr.net/v1/email/recipients/search?email=foo@bar.com \
     -H 'Content-Type: application/json'                                  \
     -H 'Authorization: Bearer $API_TOKEN'

The GET method and the link /email/recipients/search is used here

An example of a response in case of a successful HTTP request:

{
  "total_count": 2,
  "total_pages": 1,
  "page_number": 1,
  "page_size": 25,
  "collection": [
    {
      "email": "foo@bar.com",
      "recipients": [
        {
          "list_id": 1,
          "list_title": "List #1",
          "recipient_id": 1
        },
        {
          "list_id": 2,
          "list_title": "List #2",
          "recipient_id": 2
        }
      ]
    }
  ],
  "query": "test"
}

HTTP request parameters

Parameters of the items in the recipients array in the server's json response:

Have you tried Cloud4U cloud services? Not yet?

Go to the Main Website

Try for free