Menu

Contacts API - Lists

Elements that can be shared among more than one endpoint definition.

Delete a Single Recipient from a Single List

Delete a Single Recipient from a Single List

DELETE /contactdb/lists/{list_id}/recipients/{recipient_id}

This endpoint allows you to delete a single recipient from a list.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Request Body

null

Path Parameters

list_id
integer

The ID of the list that you want to add the recipient to.

required
recipient_id
string

The ID of the recipient you are adding to the list.

required

Query String

list_id
integer

The ID of the list you are taking this recipient away from.

required
recipient_id
integer

The ID of the recipient to take off the list.

required

Responses

null
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
object
errors
array[object]
message
string

the error message

field
string

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.