Delete contact identifier

Delete a contact identifier.

delete

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/contacts/{contactId}/identifiers

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

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

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

contactIdstringRequired

The ID of a contact.

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

Body

application/json

keystring · min: 1 · max: 64Required

The identifier key.

Example: secondaryEmailAddress

valuestring · min: 1 · max: 500Required

The identifier value.

Example: [email protected]

Responses

204

The identifier was deleted successfully.

No content

404

The contact, workspace or identifier was not found.

application/json

delete

/workspaces/{workspaceId}/contacts/{contactId}/identifiers

HTTPcURLJavaScriptPython

DELETE /workspaces/{workspaceId}/contacts/{contactId}/identifiers HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "key": "secondaryEmailAddress",
  "value": "[email protected]"
}

No content

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": "[email protected]"
}'

Response (204 - No Content)