Add item to recipient list

POST 
/users/:email/lists/:listname

Add item to recipient list

Request

Path Parameters

email stringrequired

The email address of the recipient whose list will be modified.

listname stringrequired

Possible values: [blocklist, safelist, blacklist, whitelist]

The name of the list to add an entry to. One of 'safelist' or 'blocklist'. 'whitelist' and 'blacklist' are deprecated

application/json

Body

required

item stringrequired

The value of the entry. The type of the entry is automatically determined based on the value.

Responses

201

Successfully created the item

application/json

Schema

Schema

item string

The value of this entry. The meaning of this value depends on the item_type.

item_type string

The item type.

action string

Which list this entry is on, e.g. safelist or blocklist.

Example (from schema)

{
  "item": "string",
  "item_type": "string",
  "action": "string"
}

400

Bad Request, returned in the case that the list item is not a valid ip address, email address or domain.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

403

Returned in the case that the domain in the user email is associated with an api key that is different than the one in the request, the user is associated with a different customer, or the domain in the user email is an alias domain.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

404

This recipient does not exist.

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

500

Internal Server Error

application/json

Schema

Schema

code integer
message string
errors string[]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "errors": [
    "string"
  ]
}

Loading...