Re-Invite a Company

After inviting a company for the first time, you may send a new invite to update information:

  • Updating the payment method on file
  • Updating tax information

This can be done in one of two ways: via email or via an embedded link.

To send the invitation via email, set the send_invite_email parameter to true. Note that if both request_payment_method and request_tax_form are selected, the company will receive one email for each request. The recipients of the email will be based on the Company's Contacts and their default_contact_for_company_management value:

  • When actionable, the contact will receive an email with a clickable link that allows them to submit information.
  • When read_only, the contact will only be notified of the invitation.
  • When none, the contact will not receive an email notification.

To use the embedded link flow, use the get_links parameter with a value of true. Note that when using get_links: true, each contact will have their own invitation URL, for each of the requests selected. You may also specify a confirmation_redirect_url to route the user to after completion of the Routable onboarding flow.

Path Params
uuid
required

The Company ID.

Body Params
uuid
required

The ID of the TeamMember performing this action. This will be displayed in the Routable Dashboard and also used as the sender of any invitation emails sent to your Company's actionable Contacts.

uri

A URL on your site that users will be redirected to after completing the onboarding external flow. For use with get_links: true.

boolean
Defaults to false
boolean
Defaults to false

If true, the invitation will request the actionable Contacts of the Company to add or update a PaymentMethod so that you can send them Payables.

boolean
Defaults to false

If true, the invitation will request the actionable Contacts of the Company to add a TaxForm (either W-8BEN, W-8BEN-E, or W-9, depending on their country and company type).

boolean
Defaults to true

If true, invitation links will be sent via email to all actionable Contacts belonging to this Company. Exactly one of get_links or send_invite_email must be true.

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json