Delete contact identifier

Delete a contact identifier.

Delete an identifier from a contact given its key and value and the contact id.

DELETEhttps://api.bird.com/workspaces/{workspaceId}/contacts/{contactId}/identifiers

Path parameters

contactId*string

The ID of a contact.

Example: "b4e02c85-c6d2-4b15-8885-e09671799c61"

Body

application/json

key*Contacts_identifierKey (string)

The identifier key.

Example: "secondaryEmailAddress"

value*Contacts_identifierValue (string)

The identifier value.

Example: "[e-mail]"

Response

204404

The identifier was deleted successfully.

Request

JavaScriptCurlPython

const response = await fetch('https://api.bird.com/workspaces/{workspaceId}/contacts/{contactId}/identifiers', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "secondaryEmailAddress",
      "value": "[e-mail]"
    }),
});
const data = await response.json();

Response

404

{
  "code": "text",
  "message": "The request body is missing the required field `service`."
}

Examples

Let's establish some of our data that will be used in the following examples:

• Workspace ID: a1405560-c8d3-4b1a-877d-3f449ad95352

• AccessKey: abcd

• Contact ID: 12bd0e40-9361-4e32-8b26-99b4ab7eae09

Delete an identifier from a contact

Request

curl -X DELETE "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/contacts/12bd0e40-9361-4e32-8b26-99b4ab7eae09/identifiers" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "key": "emailaddress",
  "value": "[e-mail]"
}'

Response (204 - No Content)