Menu

Expand
Rate this page:

Lists

Lists are static collections of Marketing Campaigns contacts. This API allows you to interact with the list objects themselves. To add contacts to a list, you must use the Contacts API.

You can also manage your lists using the Contacts menu in the Marketing Campaigns UI. For more information about lists and best practices for building them, see "Building your Contact List".

Remove Contacts from a List

DELETE /v3/marketing/lists/{id}/contacts

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

This endpoint allows you to remove contacts from a given list.

The contacts will not be deleted. Only their list membership will be changed.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Path Parameters

id
string

The ID of the list on which you want to perform the operation.

default: None
required

Query String

contact_ids
string

Comma separated list of contact ids that you want to remove from the specified contacts list.

default: None
required

Responses

object

The removal is accepted and processing.

job_id
string

job_id of the async job

object
message
string
required
field
string
error_id
string
parameter
string

If the specified list id does not exist. If the specified contact does not exist.

Loading Code Sample...
        
        

        Remove Contacts from a 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.

        Loading Code Sample...
              
              
              

              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