Your first campaign, start to finish

This walks through a renewal reminder for a property manager. Swap in your own employee, brief and people.

1. Find your employee

curl https://www.nerro.co/api/v1/employees -H "Authorization: Bearer $KEY"

Copy the id of the employee who should make the calls. It must be live and have a phone number from Nerro before launch.

2. Create the draft

curl -X POST https://www.nerro.co/api/v1/campaigns \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{
    "name": "November renewals",
    "employee_id": "EMPLOYEE_ID",
    "purpose": "informational",
    "brief": "Let {{first_name}} know the lease on unit {{unit}} ends {{lease_end}}. Ask if they plan to renew."
  }'

The answer includes the campaign's id. Words in double braces are filled in from each person's variables.

3. Add the people

curl -X POST https://www.nerro.co/api/v1/campaigns/CAMPAIGN_ID/contacts \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{
    "consent_source": "customer_opt_in",
    "consent_confirmed": true,
    "contacts": [
      { "phone": "+13125550101", "name": "Dana Lee",
        "variables": { "first_name": "Dana", "unit": "4B", "lease_end": "Dec 1" } }
    ]
  }'

4. Practice, then launch

Open the campaign in Nerro and run its practice calls. They must pass before it can launch: the API never launches an untested campaign. Then:

curl -X POST https://www.nerro.co/api/v1/campaigns/CAMPAIGN_ID/launch \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{ "consent_text": "Every person is a current tenant who agreed to be contacted by us." }'

Follow it

• GET /campaigns/CAMPAIGN_ID for counts by status and outcome, and the spend so far.
• GET /campaigns/CAMPAIGN_ID/contacts for each person.
• A webhook to get every finished call as it happens.