Delete contact identifier

Delete a contact identifier.

delete

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

Authorizations

MessageBird_userMessageBird_accessKey

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

keystring · min: 1 · max: 64required

The identifier key.

Example: secondaryEmailAddress

valuestring · min: 1 · max: 500required

The identifier value.

Example: [e-mail]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.bird.com/workspaces/{workspaceId}/contacts/{contactId}/identifiers' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "key": "secondaryEmailAddress",
    "value": "[e-mail]"
  }'

application/json

204

404

204

No body

The identifier was deleted successfully.

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)