About SendVendorInvite
Sends an invitation to the organization vendor to set up ePayments. This is a Multi Factor Authentication (MFA) protected endpoint. For more information, see the Multi Factor Authentication Workflow.
Email is sent from notificationsonly@hq.bill.com."From" value is user name, authenticated via API, based on API requester's session ID. Email body contains the default message. Custom Invitations must be personalized and sent via the UI.
If the vendor invited does not respond, another invitation cannot be sent (error is returned). The first invitation must be canceled (see CancelInvite) and then a new invite sent.
NOTE: On the Bill.com UI, invite reminders can be sent.
Example
Request
<API_URL_EndPoint>/SendVendorInvite.json
data={
"vendorId" : "yourVendorId",
"email" : "vendor123@vendor.com"
}
Response
{
"response_status" : 0,
"response_message" : "Success",
"response_data" : {"requestId"
}
}
Resources
Parameters
Request parameters
Field Name | Description | Required? |
---|---|---|
vendorId | The Bill.com ID for the vendor | Yes |
Vendor's email | Yes |
Response parameters
Field Name | Description |
---|---|
response_data | requestId for the invite |