Method :POST

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

Get Recipient By Email

Request Information

URI Parameters

None.

Body Parameters

Json format: RecipientGetByEmailBindingModel

RecipientGetByEmailBindingModel
NameDescriptionTypeAdditional information
Auth

Authorization token

AuthorizationTokenBindingModel

Required

user_email

Recipient Email. Max length: 100 characters long.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Auth": {
    "Token": "279a7949-844b-4139-9742-3a78655a063a"
  },
  "user_email": "sample string 1"
}

Response Information

Resource Description

Json format: RecipientViewModel

RecipientViewModel
NameDescriptionTypeAdditional information
user_created

Recipient created date DateTime format yyyy/MM/dd HH:mm:ss

date

None.

user_optin_date

Recipient optin date DateTime format yyyy/MM/dd HH:mm:ss

date

None.

RecipientPermissionType

Recipient Permission status

RecipientPermissionTypesForView

None.

RecipientPermissionTypeDescription

Recipient Permission status

string

None.

user_soft_bounces

Recipient number of soft bounce

integer

None.

user_hard_bounces

Recipient number of hard bounce

integer

None.

user_interests

List of interests ID

Collection of RecipientInterestViewModel

None.

user_optin_ip

IP that make the optin

string

None.

user_email

Recipient Email

string

None.

user_name

Recipient fullname

string

None.

user_address

Recipient address

string

None.

user_gender

Recipient gender: M or F

string

None.

user_phone

Recipient phone

string

None.

user_fax

Recipient fax

string

None.

user_mobile

Recipient mobile

string

None.

user_birthday

Recipient birthday

date

None.

user_spouse_birthday

Recipient spouse birthday DateTime format yyyy/MM/dd HH:mm:ss

date

None.

user_anniversary

Recipient anniversary DateTime format yyyy/MM/dd HH:mm:ss

date

None.

user_event

Recipient event DateTime format yyyy/MM/dd HH:mm:ss

date

None.

user_code

Recipient code

string

None.

user_company

Recipient company

string

None.

user_product

Recipient product

string

None.

user_other

Recipient Comment

string

None.

user_password

Recipient password

string

None.

user_tz

Recipient tz Max length: 20 chlong.

string

None.

user_url

Recipient url

string

None.

user_g1

Recipient general field

string

None.

user_g2

Recipient general field

string

None.

user_g3

Recipient general field

string

None.

user_g4

Recipient general field

string

None.

user_g5

Recipient general field

string

None.

user_g6

Recipient general field

string

None.

user_g7

Recipient general field

string

None.

user_g8

Recipient general field

string

None.

user_g9

Recipient general field

string

None.

user_g10

Recipient general field

string

None.

Response Formats

application/json, text/json

Sample:
{
  "user_created": "2018/04/25 09:21:32",
  "user_optin_date": "2018/04/25 09:21:32",
  "RecipientPermissionType": 1,
  "RecipientPermissionTypeDescription": "sample string 2",
  "user_soft_bounces": 3,
  "user_hard_bounces": 4,
  "user_interests": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "user_optin_ip": "sample string 5",
  "user_email": "sample string 6",
  "user_name": "sample string 7",
  "user_address": "sample string 8",
  "user_gender": null,
  "user_phone": "sample string 10",
  "user_fax": "sample string 11",
  "user_mobile": "sample string 12",
  "user_birthday": "2018/04/25 09:21:32",
  "user_spouse_birthday": "2018/04/25 09:21:32",
  "user_anniversary": "2018/04/25 09:21:32",
  "user_event": "2018/04/25 09:21:32",
  "user_code": "sample string 13",
  "user_company": "sample string 14",
  "user_product": "sample string 15",
  "user_other": "sample string 16",
  "user_password": "sample string 17",
  "user_tz": "sample string 18",
  "user_url": "sample string 19",
  "user_g1": "sample string 20",
  "user_g2": "sample string 21",
  "user_g3": "sample string 22",
  "user_g4": "sample string 23",
  "user_g5": "sample string 24",
  "user_g6": "sample string 25",
  "user_g7": "sample string 26",
  "user_g8": "sample string 27",
  "user_g9": "sample string 28",
  "user_g10": "sample string 29"
}