Vendor

Schedule outreach call

Schedules an AI outreach call to a vendor to collect their preferred payment method and contact email. This is the third enrichment stage. Calls are scheduled for the next business day at around 9 AM in the vendor's timezone, with retries on no-answer and a fallback payment method applied when retries are exhausted. This feature is opt-in at the org level. Contact your Payabli representative to enable it, provision a phone number, and discuss pricing.

post/Vendor/enrich/schedule_call/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Vendor/enrich/schedule_call/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

Entrypoint identifier.

Request body

vendorIdinteger required

ID of the vendor to call. Must be active and belong to the entrypoint in the path.

phonestring

Vendor phone number to call, digits only. Optional. When omitted, Payabli uses the phone number on the vendor's record. If the vendor has no phone on record, the request returns an error.

enrichmentIdstring

ID of the originating enrichment run to associate with this call. Optional. When omitted, Payabli generates a standalone call schedule and skips the enrichment lookup. The bill due-date check only runs when both enrichmentId and billId are supplied.

billIdinteger

Bill ID used for the due-date check. When the bill is due in fewer than three days, the call is skipped and the fallback method is applied. Only evaluated when enrichmentId is also supplied.

fallbackMethodstring

Payment method to apply to the vendor record if the call can't determine a preference or all retries are exhausted. Values are check (the default) or managed.

maxRetriesinteger

Number of times to retry the call if the vendor doesn't answer. Defaults to 3. Maximum is 5. The get outreach call status response reports this value as maxAttempts.

timezonestring

IANA timezone identifier used to schedule the call in the vendor's local time. Defaults to America/New_York.

sendNowboolean

When true, dispatches the call immediately and bypasses the business-hours window and the bill due-date check. Defaults to false.

Response

Success

responseCodeinteger

Code for the response. Learn more in API Response Codes.

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

Field not in use on this endpoint. It always returns 0.

isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

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