Method :POST

URL: https://apiv1.publicators.com/api/Recipients/ImportsRecipients

Import Recipients. Limited to 1500 recipients each call.

Request Information

URI Parameters

None.

Body Parameters

Json format: RecipientsImportBindingModel

Name	Description	Type	Additional information
RecipientFieldsNameToBeImported	List of fields name to be imported	Collection of string	Required
Recipients	Recipients	Collection of RecipientBindingModel	Required
ListId	List id that will contain all the imported recipients	integer	Required
Auth	Authorization token	AuthorizationTokenBindingModel	Required
StatusPermissionOnlyForNewRecipients	Set permission only for new Recipients. It's not effect on existing Recipients	RecipientPermissionTypesForBinding	Required

Request Formats

application/json, text/json

Sample:

{
  "RecipientFieldsNameToBeImported": [
    "sample string 1",
    "sample string 2"
  ],
  "Recipients": [
    {
      "user_interests": [
        {
          "Id": 1
        },
        {
          "Id": 1
        }
      ],
      "user_email": "sample string 3",
      "user_name": "sample string 4",
      "user_address": "sample string 5",
      "Recipient_Gender": 1,
      "user_phone": "sample string 7",
      "user_fax": "sample string 8",
      "user_mobile": "sample string 9",
      "user_birthday": "2024/10/08 16:57:47",
      "user_spouse_birthday": "2024/10/08 16:57:47",
      "user_anniversary": "2024/10/08 16:57:47",
      "user_event": "2024/10/08 16:57:47",
      "user_code": "sample string 10",
      "user_company": "sample string 11",
      "user_product": "sample string 12",
      "user_other": "sample string 13",
      "user_password": "sample str",
      "user_tz": "sample string 15",
      "user_url": "sample string 16",
      "user_g1": "sample string 17",
      "user_g2": "sample string 18",
      "user_g3": "sample string 19",
      "user_g4": "sample string 20",
      "user_g5": "sample string 21",
      "user_g6": "sample string 22",
      "user_g7": "sample string 23",
      "user_g8": "sample string 24",
      "user_g9": "sample string 25",
      "user_g10": "sample string 26"
    },
    {
      "user_interests": [
        {
          "Id": 1
        },
        {
          "Id": 1
        }
      ],
      "user_email": "sample string 3",
      "user_name": "sample string 4",
      "user_address": "sample string 5",
      "Recipient_Gender": 1,
      "user_phone": "sample string 7",
      "user_fax": "sample string 8",
      "user_mobile": "sample string 9",
      "user_birthday": "2024/10/08 16:57:47",
      "user_spouse_birthday": "2024/10/08 16:57:47",
      "user_anniversary": "2024/10/08 16:57:47",
      "user_event": "2024/10/08 16:57:47",
      "user_code": "sample string 10",
      "user_company": "sample string 11",
      "user_product": "sample string 12",
      "user_other": "sample string 13",
      "user_password": "sample str",
      "user_tz": "sample string 15",
      "user_url": "sample string 16",
      "user_g1": "sample string 17",
      "user_g2": "sample string 18",
      "user_g3": "sample string 19",
      "user_g4": "sample string 20",
      "user_g5": "sample string 21",
      "user_g6": "sample string 22",
      "user_g7": "sample string 23",
      "user_g8": "sample string 24",
      "user_g9": "sample string 25",
      "user_g10": "sample string 26"
    }
  ],
  "ListId": 1,
  "Auth": {
    "Token": "d4b157cf-cf02-4f99-8e0a-a0fffcac08fe"
  },
  "StatusPermissionOnlyForNewRecipients": 1
}

Response Information

Resource Description

Json format: RecipientsImportResultsViewModel

RecipientsImportResultsViewModel

Name	Description	Type	Additional information
IncomingRecords	Total recieved records	integer	None.
InvalidEmails	Total invalid emails	integer	None.
DuplicatedEmails	Total duplicated emails	integer	None.
UpdatedEmails	Total updates emails	integer	None.
NewEmails	Total new emails	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "IncomingRecords": 1,
  "InvalidEmails": 2,
  "DuplicatedEmails": 3,
  "UpdatedEmails": 4,
  "NewEmails": 5
}