Method :POST

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

Change recipients delivery status. Does not affect on recipients that already in removal state.

Request Information

URI Parameters

None.

Body Parameters

Json format: RecipientsPermissionBindingModel

RecipientsPermissionBindingModel
NameDescriptionTypeAdditional information
Auth

Authorization token

AuthorizationTokenBindingModel

Required

Emails

Recipients emails

Collection of string

Required

RecipientPermission

Recipient Permission

RecipientPermissionTypesWithRemovalForBinding

Required

Request Formats

application/json, text/json

Sample:
{
  "Auth": {
    "Token": "24f201ce-cd0e-4726-a89c-17bde674ce1c"
  },
  "Emails": [
    "sample string 1",
    "sample string 2"
  ],
  "RecipientPermission": 1
}

Response Information

Resource Description

Json format: RecipientsChangePermissiontResultsViewModel

RecipientsChangePermissiontResultsViewModel
NameDescriptionTypeAdditional 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.

NotExistingEmails

Total not found emails

integer

None.

EmailsFailedAlreadyInRemovalState

Total emails that were in removal state and can not be updated

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "IncomingRecords": 1,
  "InvalidEmails": 2,
  "DuplicatedEmails": 3,
  "UpdatedEmails": 4,
  "NotExistingEmails": 5,
  "EmailsFailedAlreadyInRemovalState": 6
}