Skip to content Skip to navigation Skip to topbar

Delete a Contact Identifier

Operation overview

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".

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

contact_idstringrequired

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

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

identifier_typestringrequired

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

identifier_valuestringrequired

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

Responses

202400401403404500

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

Schema

Property nameTypeRequiredDescriptionChild properties

job_idobject

The deletion job ID.

Delete a Contact Identifier

Node.js

Python

Java

PHP

Ruby

curl


_23const client = require('@sendgrid/client');
_23client.setApiKey(process.env.SENDGRID_API_KEY);
_23
_23const contact_id = "ZGkrHSypTsudrGkmdpJJ";
_23const data = {
_23  "identifier_type": "PHONENUMBERID",
_23  "identifier_value": "+15555555555"
_23};
_23
_23const request = {
_23  url: `/v3/marketing/contacts/${contact_id}/identifiers`,
_23  method: 'DELETE',
_23  body: data
_23}
_23
_23client.request(request)
_23  .then(([response, body]) => {
_23    console.log(response.statusCode);
_23    console.log(response.body);
_23  })
_23  .catch(error => {
_23    console.error(error);
_23  });