Browse API reference

Delete a mailing list recipient

deletehttps://api.intelliprint.net/v1/mailing_lists/{mailing_list}/recipients/{id}

Deletes a mailing list recipient by its ID.

Parameters

Path

mailing_listrequired

string

The ID of the mailing list the recipient belongs to.

idrequired

string

The ID of the recipient to delete.

Responses

Sample JSON for every response shape is in the right rail. Expand a row below to see every field this endpoint can return.

200Successful responseapplication/json

id

string

The ID of the deleted mailing list recipient.

Example"mal_rcp_eg"

object

string

The object type. Always mailing_list_recipient.

Allowed valuesmailing_list_recipient

deleted

boolean

Whether the mailing list recipient was successfully deleted. Always true.

Exampletrue

400Example error responseapplication/json

error

object

messagestring

A human-readable message describing the error. You can display this to your users to help them understand what went wrong.

Example"Received unknown parameter: testmood (Did you mean testmode?)"

typestring

The general category of the error.

Allowed valuesinvalid_request_errorauthentication_errorpayment_errorrate_limitedinternal_error

Example"invalid_request_error"

codestring

A unique code for the specific error that occurred.

Allowed valuesparameter_invalidparameter_missingparameter_unknownbody_too_largebody_incorrect_formatno_api_keyinvalid_api_keylogged_outforbiddenpayment_errornot_foundrate_limitedrefusedinternal_error

Example"parameter_unknown"

paramstring

The parameter that caused the error, if applicable.

Example"testmood"

Request example

cURL

curl -X DELETE https://api.intelliprint.net/v1/mailing_lists/mailing-list-id/recipients/recipient-id \ 
  -H 'Authorization: YOUR_API_KEY'

Node.js SDK

Node.js

import Intelliprint from 'intelliprint'
const ip = Intelliprint('your-api-key-here')

const deleted = await ip.mailing_list_recipients.delete('mailing-list-id', 'recipient-id')

Example response

200 · Successful response

JSON

{
  "id": "mal_rcp_eg",
  "object": "mailing_list_recipient",
  "deleted": true
}

400 · Example error response

JSON

{
  "error": {
    "message": "Received unknown parameter: testmood (Did you mean testmode?)",
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "param": "testmood"
  }
}