Delete Citizen Contacts

Deletes the specified contacts for the specified citizen user.

Resource Information

Scopeusers

Deprecated scope name:   delete_citizenaccess_citizens_contacts

App TypeAll
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/{id}/contacts/{contactIds}?lang={lang}
HTTP MethodDELETE
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
contactIdsstringYes An array containing the contact IDs.7.3.3.4
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4

Example

Sample Request Head

DELETE https://apis.accela.com/v4/citizenaccess/citizens/8661/contacts/912

Notes

This example assumes the logged-in user is an authorized agent.

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.3.4
result.failedCountlongThe number of failed results.7.3.3.4
result.failedIDsstringThe IDs of the entities on which the operation failed.7.3.3.4
result.successCountlongThe number of successful results.7.3.3.4
result.successIDsstringThe IDs of the entities on which the operation succeeded.7.3.3.4
statusintegerThe record status.7.3.3.4

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "successCount": 1,
    "failedCount": 0,
    "failedIDs": []
  }
}