Delete Item #

Deletes an existing item from a directory.

Request #

DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID}

Example #

This request will delete the specific item within the directory.

Request #

DELETE https://api.na.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123 HTTP/1.1
Authorization: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"data": {
        "id": "00000000-0000-0000-0000-000000000123",
        "fields": {
            "title": "Mr",
            "fullName": "CRM3a",
            "companyName": "Company",
            "jobTitle": "Job Title",
            "phone1": "+44XXXXXXXXXX",
            "email": "Email Address",
            "field1": "field1",
            "field2": "field2",
            "crmId": "00000000-0000-0000-0000-000000000001"
        }
    },
	"status": "success",
	"timestamp": "2019-01-01T10:00:00.2890319Z"
}

Errors #

Unauthorized #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorized

Bad Request (1) #

When the provided directory id is not in the correct format

HTTP/1.1 400 Bad Request
Date: Thu, 06 Feb 2020 12:45:27 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 149
{
	"error":400,
	"message":"The value '<directory id>' is not valid.",
	"status":"error",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Bad Request (2) #

When the provided directory item id is not in the correct format

HTTP/1.1 400 Bad Request
Date: Thu, 06 Feb 2020 12:45:27 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 149
{
	"error":400,
	"message":"The value '<user id>' is not valid.",
	"status":"error",
	"timestamp":"2020-02-06T12:45:27.5903465Z"
}

Not Found #

When there are no directory items that have a matching id.

HTTP/1.1 404 Not Found
Date: Thu, 06 Feb 2020 12:46:58 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 95
{
	"error":404,
	"message":"Not Found",
	"status":"error",
	"timestamp":"2020-02-06T12:46:58.7669535Z"
}