VOvopay
Partner Endpoints

partner/users/delete

Changed on

This endpoint deletes a portal user of the partner account. Requires an Admin portal user (Authorization bearer token).

post/partner/users/delete

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/users/delete
  • 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

EmailAddressstring required

Email address of the user to delete

PartnerAccountIDstring

APIAccountID of a partner account created by the caller. When set, the request acts on that partner account's portal users instead of the caller's. Requires PartnerCreationEnabled; returns RESOURCE_NOT_FOUND for a partner account the caller didn't create. The admin-user check still applies to the caller.

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

UserIDinteger required

ID of the deleted user

IsActiveinteger required

Always 0 after deletion

Example response

{
  "Success": true,
  "UserID": 1234
}

Changes