Partner Endpoints

partner/onboarding/application/remind

Changed on

Partner portal Onboarding Tracker Remind action. The onboarding app sends the entity's applicant its reminder email, whatever the partner's PartnerEmailsAccount setting. The entity must be in the partner's book, in Application Pending, and have an onboarding application: an entity that does not exist, one outside the book and one with no status get the same not-found error as the application details, and one in another stage or without an application gets an invalid-action error. If the onboarding app cannot be reached or fails, the request fails with an integration error. Writes an account note (a partner note for a child partner) naming the portal user. Requires a partner portal session (bearer token) of an Admin user and the AccountOnboardingFormAccess permission; Viewer and Support users are rejected.

post/partner/onboarding/application/remind

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/onboarding/application/remind
  • Auth
    none declared

Request body application/x-www-form-urlencoded

EntityTypestring required

Partner, Account or SubAccount, as the entity list returns it.

EntityIDstring required

The entity's EntityID from the entity list: the account ID, or the child partner's partner account ID.

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

LastReminderSentDatestring required

When the reminder was sent, UTC, YYYY-MM-DD HH:MM:SS (the same format as the application details' LastReminderSentDate): the onboarding app's last reminder time, read back after the send, or the time earthnode sent it when the app's value cannot be read back.

Example response

{
  "Success": true,
  "LastReminderSentDate": "2026-10-09 17:05:12"
}

Changes