Frequently Asked Questions
Quick answers to common inquiries
- How do I report a bug?
- How do I create an API key?
- How do I copy my API key from Sandbox to www (production)?
- How to I contact Developer Support?
- How do I register a Webhook?
- I'm able to create a note using the API, but I get "PERMISSION_DENIED" when I call
- I want to do some testing with a Premium account, can I upgrade my account on Sandbox?
- Why can't I delete a (note, notebook, tag)?
- Why can't I use the class or id attributes in ENML?
- Do you offer a white-labelled version of the Evernote service?
- Is there a public API for creating Evernote accounts?
- Can I build a plugin for one of your apps?
- Thrift? Why Thrift?
How do I report a bug?
How do I create an API key?
You can create a new API key by completing and submitting the API Key Request form available at the top of this page (click the API Key button to show the form). Your API key will be immediately available on Sandbox, our development server.
How do I copy my API key from Sandbox to www (production)?
This process is called key activation. To activate your API key on Evernote’s production servers, file a key activation request using this form. Once we’ve determined that your integration fulfills all of the requirements of a production application, your key will be activated within 1–2 business days. You’ll be notified when your key has been activated (or if there’s an issue with your application that needs to be addressed).
Note: your API key on Sandbox will still be active and available after your key has been activated on production.
How to I contact Developer Support?
If you've exhausted the other support options (browsing the FAQ, searching the developer site and user forum) and still need assistance you can contact our developer support department for assistance. Note: if you're not a developer and require assistance, you can get general support here.
How do I register a Webhook?
To register a Webhook, complete a Developer Support request. Include the URL your Webhook will access and the Note filter that should be applied. Once we’ve received your request, your Webhook will be activated, typically within 1–2 business days. You’ll receive email confirmation when your Webhook has been activated.
I'm able to create a note using the API, but I get "PERMISSION_DENIED" when I call
Evernote Cloud API keys are assigned one of two sets of access: basic and full. Keys with basic access can create Notes as well as list a user’s Notebooks, Tags and Saved Searches. Keys with full access can perform the same actions as with basic access, but can also read and modify existing Notes in a user’s account.
If you’re attempting to call functions that will read or modify a user’s existing Notes (e.g.,
getNote) using API credentials that only have basic access, a PERMISSION_DENIED error will occur. If you feel your API key needs full access to the user’s account, contact developer support to have your API key modified.
I want to do some testing with a Premium account, can I upgrade my account on Sandbox?
Absolutely. Contact developer support and include the username on Sandbox you’d like upgraded to premium and we’ll upgrade the account for you.
Why can't I delete a (note, notebook, tag)?
Despite being defined in the Evernote API reference, calling any of the functions beginning with
expunge will result in a
PERMISSION_DENIED error. These functions will permanently remove their respective parameters from the user’s Evernote account and are not available to third-party developers. You can, however, call
deleteNote to move a Note to the Trash.
Why can't I use the class or id attributes in ENML?
Evernote Notes routinely contain entire web pages, sometimes multiple pages in a single note. In this case, there’s a possibility of a collision (i.e., two separate elements in the note with the same ID or class). This can cause unintended side-effects when stylesheets are processed and applied to the contents of a Note, so it is not supported.
Do you offer a white-labelled version of the Evernote service?
No, we're 100% focused on our existing consumer offering. When you use the Evernote API, you're accessing the accounts of individual users who have signed up for Evernote an account and authorized you to access it.
Is there a public API for creating Evernote accounts?
No, we don't expose our account creation API publicly. Initial user experience is critical to our success, so we need to carefully control that process. We're working on registration frameworks for popular development environments (read: iOS and Android) so that you can embed an Evernote account creation experience into your application.
Can I build a plugin for one of your apps?
No, we don't have any plugin mechanism today. When you use our API, you're accessing the Evernote web service or one of our clients from your own external application.
Thrift? Why Thrift?
Our web service API is a bit unique in that it's build on the Apache Thrift framework. As a developer consuming our API, you generally won't have to think about Thrift, but if you're curious about why we chose it, check out Dave's blog post So API Together: Evernote and Thrift.