VOvopay
Partner Endpoints

partner/user

Changed on

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

post/partner/user

Request

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

Rolestring required

Role of the new user (Admin, Support or Viewer)

SendEmailboolean

Whether to email the credentials to the new user. Defaults to true.

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

Usernamestring required

Email address of the created user

Passwordstring required

Generated password of the created user

Example response

{
  "Success": true,
  "Username": "user@acme.example",
  "Password": "Xk3!pQ9z"
}

Changes