# Delete a Contact Identifier ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/marketing/contacts/{contact_id}/identifiers","method":"delete","servers":[{"url":"https://api.sendgrid.com","description":"The Twilio SendGrid v3 API"}]} ``` **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 ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}}] ``` ### Path parameters ```json [{"name":"contact_id","in":"path","description":"Must be set to the `contact_id` of the contact you want to remove the identifier from.","required":true,"schema":{"type":"string"}}] ``` ### Request body ```json {"schema":{"type":"object","required":["identifier_type","identifier_value"],"example":{"identifier_type":"PHONENUMBERID","identifier_value":"15555555555"},"properties":{"identifier_type":{"type":"string","description":"The type of identifier you are removing from the contact.","enum":["EMAIL","PHONENUMBERID","EXTERNALID","ANONYMOUSID"],"refName":"IdentifierType","modelName":"IdentifierType"},"identifier_value":{"type":"string","description":"The value of the identifier you want to remove from the contact."}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"202","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","description":"Indicates that the deletion is queued for processing. Check the job status with the Import Contacts Status endpoint.","required":["job_id"],"properties":{"job_id":{"type":"object","description":"The deletion job ID."}}}}}}},{"responseCode":"400","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object"}}}}}}}},{"responseCode":"401","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/MarketingContacts401","modelName":"__components_responses_MarketingContacts401"}},{"responseCode":"403","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/MarketingContacts403","modelName":"__components_responses_MarketingContacts403"}},{"responseCode":"404","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}}}},"refName":"#/components/responses/MarketingContacts404","modelName":"__components_responses_MarketingContacts404"}},{"responseCode":"500","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"refName":"#/components/responses/MarketingContacts500","modelName":"__components_responses_MarketingContacts500"}}] ``` Delete a Contact Identifier ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const contact_id = "contact_id"; const data = { identifier_type: "PHONENUMBERID", identifier_value: "15555555555", }; const request = { url: `/v3/marketing/contacts/${contact_id}/identifiers`, method: "DELETE", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) contact_id = "contact_id" data = {"identifier_type": "PHONENUMBERID", "identifier_value": "15555555555"} response = sg.client.marketing.contacts._(contact_id).identifiers.delete( request_body=data ) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var contactId = "contact_id"; var data = @"{ ""identifier_type"": ""PHONENUMBERID"", ""identifier_value"": ""15555555555"" }"; var response = await client.RequestAsync( method: SendGridClient.Method.DELETE, urlPath: $"marketing/contacts/{contactId}/identifiers", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; import java.util.Arrays; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.DELETE); request.setEndpoint("/marketing/contacts/contact_id/identifiers"); request.setBody(new JSONObject(new HashMap() { { put("identifier_type", "PHONENUMBERID"); put("identifier_value", "15555555555"); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/marketing/contacts/contact_id/identifiers", host) request.Method = "DELETE" request.Body = []byte(`{ "identifier_type": "PHONENUMBERID", "identifier_value": "15555555555" }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "identifier_type": "PHONENUMBERID", "identifier_value": "15555555555" }'); $contact_id = "contact_id"; try { $response = $sg->client ->marketing() ->contacts() ->_($contact_id) ->identifiers() ->delete($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) contact_id = "contact_id" data = JSON.parse('{ "identifier_type": "PHONENUMBERID", "identifier_value": "15555555555" }') response = sg.client.marketing.contacts._(contact_id).identifiers.delete(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X DELETE "https://api.sendgrid.com/v3/marketing/contacts/contact_id/identifiers" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"identifier_type": "PHONENUMBERID", "identifier_value": "15555555555"}' ```