Menu

Expand
Rate this page:

Contacts API - Lists

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

Delete a Single Recipient from a Single List

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

Base url: https://api.sendgrid.com

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.

default: None
required
recipient_id
string

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

default: None
required

Query String

list_id
integer

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

default: None
required
recipient_id
integer

The ID of the recipient to take off the list.

default: None
required

Responses

null
object
errors
array[object]
message
string

the error message

required
field
string or null

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

required
field
string or null

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

required
field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

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

        Delete a Single Recipient from a Single List

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif