/deleteContact

1 min

POST

/deleteContact

This API allows deleting a contact from the MPC.

    -------------------- Request --------------------

            deleteContact(
                  Ids=["1:0xdDebc4dC243011EbE2e33c05BA877F9c0bA2Ed8C"],
                  RequestExtraData={
                        "MessageNumber"=5,
                        "SessionId"="3478593863424051983840947"
                        },
                  force_delete=False
                  )

    -------------------- Response --------------------

            {
            "FunctionData": {
                "StatusCode": 0,
                "StatusCodeDescription": "Contact deleted successfully"
            },
            "Meta": {
                "AccessToken": "e59612cdcb1242af750f4f8cc9032a4d44bfdb40b00bd19c5e5ef5d538fc74a0",
                "Destination": "0473aa0362d3998baab6880822e838133a061c379b8e146bcded46deb4805aa83139a3c578293161bca7926e53ef20888977f4030c38d42aae10b36c3309c0f766",
                "Source": "762b6aa122a0ba22557a0cf5ea0c49953e64f7485ffb7857f26541f748e36e83b2e4cca777569511214fcf68f3301a322bbdf15e7479ae0d695fcf40c30a81ff56",
                "Time": "2025-09-30 15:25:43.678"
            }
        }

Returns: JSON file containing the success or error response.

Error Responses

Error Type	Http Code	GK8 error code	Reason / Description	Example Response
Backend Response	400	1	Unknown contact	"StatusCode": 1
Backend Response	400	2	System generated account contact cannot be deleted	"StatusCode": 2
Backend Response	400	3	Contact is already in use in address group	"StatusCode": 3, "AddressGroupIds": ["1", "2"]
Backend Response	400	4	Contact is already in use in policy	"StatusCode": 4, "PolicyIds": ["1"]

contact_idstring<p>the id of the contact - ids of existing contacts can be retrieved by running getAllContacts API.</p>

request_extra_dataobjectadditional data for the administrative request

force_deleteboolean<p>indication whether to forcefully delete the contact even if it exists in other policies / groups</p>

acceptstringGenerated from available response content types

200success

curl --request POST \
     --url '/deleteContact?contact_id=contact%20ID&request_extra_data=%22None%22&force_delete=boolean' \
     --header 'accept: application/json'