Ramp provides an integration with Gmail and Outlook, which can automatically upload receipts to your Ramp transactions. If you've set this up but want to skip specific users, you can opt them out of the integration with the following steps:
Setup
Step 1: Visit docs.ramp.com to get started with the Developer API
Step 2: Setup your app in the Ramp Developer dashboard – note you need to be an admin on Ramp to access this page.
Step 3: Follow the instructions listed here for authorizing your request. We recommend setting up the app using the “Client Credentials” method since your company will be using this as an internal tool, and it’s easier not to have to worry about refresh_tokens in this scenario.
The only scopes required for Opt out list read/write are:
receipt_integrations:read
receipt_integrations:write
Using the API
Follow the Receipt integrations section to add, remove, or list the emails that are opted out of the Gmail or Outlook integrations
1. List users
GET /developer/v1/receipt-integrations/opt-out
2. Opt out a new user
POST /developer/v1/receipt-integrations/opt-out
Note: For adding an entry to the opt-out list, the POST requires an email in the JSON payload formatted as follows: {“email”: “[your email address]”}
3. Remove an opt-out (re-enable the gmail integration for a given user)
DELETE /developer/v1/receipt-integrations/opt-out/{mailbox_opted_out_email_uuid}
Note: For this to function properly, your company's internal tools will need to perform one of the two following functions:
- Store the mailbox_opted_out_email_uuid returned by the POST endpoint to later delete the opt out entry
- Fetch all opted out emails from the GET, filter it on the specific email you want removed from the opt-out list, and then delete the email from the opt-out list