Delete contact

What it does

You can delete a contact.

Endpoint

DELETE

/byon/contacts/v1/{contactId}

Request Body

Attributes

Description

contactId
required (path)

The unique identifier of the contact to delete.

Curl

curl -X DELETE "https://api.tyntec.com/byon/contacts/v1/26c99e4d97b44c9aa50bf7fb29801ebe" -H  "accept: application/json" -H  "apiKey: ds9SomeApiKeyl337"

 

Responses

Code

Details

200

The deleted contact
Example Value

{
  "accountId": "string",
  "contactId": "string",
  "friendlyName": "string",
  "companyName": "string",
  "companyAddress": "string",
  "contactName": "string",
  "contactEmail": "string",
  "contactPhone": "string",
  "dateCreated": 0,
  "dateUpdated": 0,
  "timestampCreated": "string",
  "timestampUpdated": "string"
}

Example

Response body

{
  "accountId": "CPaasAccountName",
  "contactId": "26c99e4d97b44c9aa50bf7fb29801ebe",
  "friendlyName": "myFriendlyName",
  "companyName": "myCompanyName",
  "companyAddress": "myCompanyAddress",
  "contactName": "myContactName",
  "contactEmail": "mail@myemail.com",
  "contactPhone": "+49231123456789",
  "dateCreated": 1521117972092,
  "dateUpdated": 1521125758284,
  "timestampCreated": "2018-03-15T14:55:58.284Z",
  "timestampUpdated": "2018-03-15T14:55:58.284Z"
}

400

Contact can not be deleted

401

Unauthorized

403

Forbidden

404

Contact not found

500

Something went wrong :-(Example Value{  "code": "string",  "message": "string",  "timestamp": 0}