Menu

Expand
Rate this page:

Contacts

Delete a Contact Identifier

DELETE /v3/marketing/contacts/{contact_id}/identifiers

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

This endpoint can be used to delete one identifier from a contact.

Deletion jobs are processed asynchronously.

Note this is different from deleting a contact. If the contact has only one identifier, the asynchronous request will fail. All contacts are required to have at least one identifier.

The request body field identifier_type must have a valid value of "EMAIL", "PHONENUMBERID","EXTERNALID", or "ANONYMOUSID".

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
identifier_type
string

A type of the following: EMAIL, PHONENUMBERID, EXTERNALID, or ANONYMOUSID.

required
identifier_value
string

The value of the identifier you want to remove from the contact.

required
{
  "identifier_type": "PHONENUMBERID",
  "identifier_value": "+14152279968"
}

Path Parameters

contact_id
string

Must be set to the contact_id of the contact you want to remove the identifier from.

default: None
required

Responses

object

Indicates that the deletion is queued for processing. Check the job status with the Import Contacts Status endpoint.

job_id
object

The deletion job ID.

required
object
errors
array[object]
required
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"
    }
  ]
}
object
errors
array[object]
message
string
Loading Code Sample...
        
        

        Delete a Contact Identifier

        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