Delete Contact label For Specific Contact

From docs
Jump to: navigation, search

Remove Contact Label

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact/{id}/label/{label_id}

Purpose

Removes a label assignment from a specific contact. The label is detached from the contact; this does not delete the label definition itself.

HTTP Method

DELETE

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
id integer Yes Unique identifier of the contact
label_id integer Yes Unique identifier of the label to remove from the contact

Query Parameters

None.

Request Body

None.

Successful Response (200)

Indicates that the label was removed from the contact successfully.

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
message string Confirmation message (for example, "contact label removed successfully")
uri string Requested resource URI

Error Responses

Status Code Meaning
400 Bad Request – the label could not be removed
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – Invalid label ID ("Label Id is Invalid"), or another error while removing the label from the contact.
  • 401 – Authentication failed or the access token is missing/expired.