VOvopay
Contact Endpoints

contacts/deactivate

This endpoint is used to deactivate a contact

post/contacts/deactivate

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/contacts/deactivate
  • Auth
    none declared

Request body application/x-www-form-urlencoded

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

ContactIDstring required

The ID for the contact you wish to deactivate

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

ContactIDstring required

This ID of the deactivated contact

IsActivestring required

The status of the deactivated contact

DateDeactivatedstring required

The date and time the contact was deactivated

Example response

{
  "Success": true,
  "ContactID": "test_contact_id",
  "IsActive": "0",
  "DateDeactivated": "2024-04-04 04:04:04"
}

Changes

No recorded changes to this operation across all 1 revision of this API.