Authentication, errors and limits

Create a key

In Nerro, open Connectors, choose Zapier and press Create API key. The same key works for Zapier and the API. It starts with nrz_ and is shown once, so copy it somewhere safe.

Pressing Replace key makes a new one and stops the old key straight away, including any Zaps using it. A key has full access to your business, so keep it on your server, never in a web page or app.

Send it on every request

curl https://www.nerro.co/api/v1/me \
  -H "Authorization: Bearer nrz_your_key"

An X-API-Key: nrz_your_key header works too. A good key answers:

{ "data": { "business": "Larkhaven Realty" } }

Errors

Every error has the same shape, with a sentence you can show a person:

{ "error": { "message": "Attempts must be between 1 and 9." } }

• 400: the request isn't right: a missing or wrong field, a body that isn't JSON, or a step that isn't allowed yet (like launching before the practice calls pass). The message says which.
• 401: the key is missing, wrong or was replaced.
• 404: no such endpoint or campaign action.
• 429: too many requests. Wait a minute and try again.
• 503: outbound calling isn't available right now. Try again later.
• 500: something went wrong on our side. It's logged, and it's safe to retry.

Limits

• 120 requests a minute per key.
• 20 failed sign-ins a minute from one address, then 429 for the rest of that minute.
• List endpoints return at most 100 items a call.
• A campaign takes at most 5,000 people in one request.