Sign in Get started

API reference

API reference

Every operation, grouped by what it works on. Each page shows the scope it needs, its fields, examples and the errors it can answer.

Base URLhttps://api.norreach.app/v1AuthenticationA bearer API key with the scopes the operation needs.OpenAPIThe whole API as openapi.json, for your tools.

Ads

GET/ad-accountsList ad accounts GET/ad-launchesList ad launches GET/ad-launches/{id}Get an ad launch PATCH/ad-launches/{id}Change an ad launch's budget, schedule or name POST/ad-launches/{id}/publishPublish an ad launch POST/ad-launches/{id}/discardSend an ad launch back to a draft GET/ads/insightsAd results GET/ad-campaignsList live ad campaigns POST/ad-campaigns/{id}/pausePause a live ad campaign POST/ad-campaigns/{id}/resumeSwitch a live ad campaign back on GET/ad-accounts/{id}/spending-limitAn ad account's spending limit PUT/ad-accounts/{id}/spending-limitSet or remove an ad account's spending limit POST/ad-accounts/{id}/spending-limit/resetStart a new spending-limit period

Analytics

GET/analytics/overviewGet the analytics overview GET/analytics/channelsGet analytics per channel GET/analytics/callsGet AI call analytics GET/analytics/campaigns/{id}Get one campaign's analytics

Approvals

GET/approvalsList what waits for approval GET/approvals/{key}One waiting item POST/approvals/{key}/approveApprove an item POST/approvals/{key}/skipSkip an item POST/approvals/decideDecide several items POST/approvals/{key}/redraftChange an item in words

Audit log

GET/audit-logList the audit log

Automations

GET/automationsList automations POST/automationsSave a new automation GET/automations/{id}One automation PATCH/automations/{id}Rename an automation or replace its flow POST/automations/{id}/activateActivate an automation POST/automations/{id}/pausePause an automation POST/automations/{id}/stopStop an automation for good GET/automations/{id}/analyticsAn automation's numbers GET/automations/{id}/logsAn automation's execution log

Calls

GET/callsList calls GET/calls/{id}One call, or where an API call request stands GET/calls/{id}/transcriptA call's transcript POST/callsRequest an AI call GET/voice-agentsYour voice agents GET/voicesList voices GET/voice-agents/{id}Get a voice agent POST/voice-agentsCreate a voice agent PATCH/voice-agents/{id}Change a voice agent GET/inbound-routingWho answers incoming calls POST/inbound-routing/rulesAdd a routing rule PATCH/inbound-routing/rules/{id}Change a routing rule DELETE/inbound-routing/rules/{id}Remove a routing rule PUT/phone-numbers/{id}/inbound-modeWho answers a number: the AI agent or the call menu

Campaigns

GET/campaignsList campaigns POST/campaignsCreate a draft campaign GET/campaigns/{id}One campaign PATCH/campaigns/{id}Change a campaign's basics or settings PUT/campaigns/{id}/sequenceReplace a draft's sequence PUT/campaigns/{id}/rulesReplace a draft's rules POST/campaigns/{id}/cloneClone a campaign POST/campaigns/{id}/launchLaunch a campaign POST/campaigns/{id}/pausePause a campaign POST/campaigns/{id}/resumeResume a paused campaign POST/campaigns/{id}/enrollmentsEnroll contacts GET/campaigns/{id}/enrollmentsList a campaign's enrollments GET/enrollments/{id}One enrollment PATCH/enrollments/{id}Pause, resume or remove one contact GET/sequence-templatesList sequence templates

Contacts

GET/contactsList contacts POST/contactsCreate a contact POST/contacts/batchCreate or update many contacts GET/contacts/{id}One contact PATCH/contacts/{id}Update a contact DELETE/contacts/{id}Erase a contact POST/contacts/{id}/notesAdd a note PUT/contacts/{id}/consentSet the lawful basis POST/contacts/{id}/stageMove to a stage POST/contacts/{id}/tags/{tag}Tag a contact DELETE/contacts/{id}/tags/{tag}Untag a contact GET/tagsList tags GET/contacts/{id}/leadsA contact's form leads GET/companiesList companies

Credits

GET/creditsGet the credit balance GET/credits/ledgerList the credit ledger GET/credits/pricesList what actions cost

Deals

GET/dealsList deals POST/deals/{id}/moveMove a deal

Do-not-contact

GET/suppressionsList do-not-contact entries POST/suppressionsAdd a do-not-contact entry

Inbox

GET/threadsList conversations GET/threads/{id}One conversation GET/threads/{id}/messagesA conversation's messages POST/threads/{id}/readMark a conversation read POST/threads/{id}/draftDraft a reply POST/threads/{id}/replyReply on a conversation POST/messagesSend a message GET/messages/{id}One message, or where an API send stands GET/templatesMessage and WhatsApp templates

Landing pages

GET/sitesList sites GET/sites/{id}One site PATCH/sites/{id}Update a site GET/pagesList pages GET/pages/{id}One page GET/pages/{id}/versionsA page's versions GET/versions/{id}One page version PATCH/pages/{id}/draftEdit a page's working copy POST/pages/{id}/versionsSave a version POST/pages/{id}/submitSend for approval POST/pages/{id}/publishPublish a page POST/pages/{id}/unpublishTake a page down GET/pages/{id}/preview-linkA preview link GET/leadsList form leads GET/pages/{id}/leadsA page's form leads POST/leads/exportExport form leads GET/pages/{id}/analyticsA page's analytics GET/sites/{id}/domainsA site's custom domains POST/sites/{id}/domainsAdd a custom domain POST/sites/{id}/domains/{domain_id}/verifyCheck a custom domain POST/sites/{id}/domains/{domain_id}/primaryMake a domain the main address DELETE/sites/{id}/domains/{domain_id}Remove a custom domain

Lists

GET/listsList lists POST/listsCreate a list GET/lists/{id}/membersList a list's members POST/lists/{id}/membersAdd contacts to a list DELETE/lists/{id}/membersRemove contacts from a list

Meetings

GET/meetingsList meetings GET/meetings/{id}One meeting POST/meetingsBook a meeting with a contact POST/meetings/{id}/approveApprove a meeting POST/meetings/{id}/declineDecline or cancel a meeting POST/meetings/{id}/reassignHand a meeting to someone else GET/booking-pagesYour booking page GET/meeting-typesList meeting types GET/availabilityFree times

Nora

POST/nora/askAsk Nora a question POST/nora/runsGive Nora a task GET/nora/runsList Nora's tasks GET/nora/runs/{id}Get a Nora task

Phone numbers

GET/phone-numbersList phone numbers GET/phone-numbers/availableSearch numbers to buy GET/number-verificationsList business verifications GET/number-verifications/requirementsWhat a business verification needs POST/number-verificationsSubmit a business verification POST/phone-numbersBuy a phone number

Plans

GET/plansList plans GET/plans/{id}One plan POST/briefsFile a brief — Nora writes a plan GET/plans/{id}/generationHow far Nora is with a plan GET/plans/{id}/cardsA plan's cards GET/cards/{id}One plan card PATCH/cards/{id}Change a card's words POST/cards/{id}/approveApprove a plan card POST/cards/{id}/skipSkip a plan card POST/plans/{id}/replanAsk Nora to change a plan POST/plans/{id}/replan/applyApply Nora's proposal POST/plans/{id}/activateStart a plan POST/plans/{id}/pausePause a plan PUT/plans/{id}/autonomySet what Nora may do without asking

GET/social/accountsList connected social profiles GET/social/postsList social posts GET/social/posts/{id}Get a social post POST/social/postsCreate a social post PATCH/social/posts/{id}Change a social post DELETE/social/posts/{id}Delete a social post POST/social/posts/{id}/scheduleSchedule a social post POST/social/posts/{id}/unscheduleUnschedule a social post POST/social/uploadsUpload a picture or video for a post

Team

GET/membersList members PATCH/members/{id}Change a member's role or switch them off GET/invitesList pending invites POST/invitesInvite someone DELETE/invites/{id}Cancel an invite GET/members/{id}/scheduleA member's working hours PUT/members/{id}/scheduleSet a member's working hours GET/team-requestsList the team's requests GET/team-requests/{id}Get a request PATCH/team-requests/{id}Decide a request POST/team-requests/{id}/repliesReply to a request

Templates

GET/whatsapp-templatesList WhatsApp templates POST/whatsapp-templatesSubmit a WhatsApp template for review POST/whatsapp-templates/syncSync WhatsApp templates POST/templatesSave a message template PATCH/templates/{id}Change a message template DELETE/templates/{id}Delete a message template

Webhooks

GET/webhook-endpointsList webhook endpoints POST/webhook-endpointsAdd a webhook endpoint GET/webhook-endpoints/{id}One webhook endpoint PATCH/webhook-endpoints/{id}Change a webhook endpoint DELETE/webhook-endpoints/{id}Remove a webhook endpoint POST/webhook-endpoints/{id}/rotate-secretRotate the signing secret POST/webhook-endpoints/{id}/testSend a test event GET/webhook-endpoints/{id}/deliveriesAn endpoint's deliveries GET/webhook-deliveries/{id}One delivery POST/webhook-deliveries/{id}/redeliverSend a delivery again GET/event-typesThe event catalogue GET/eventsPoll events

Workspace

GET/meWho this key is GET/openapi.jsonThe OpenAPI document GET/jobs/{id}One async job GET/workspaceThe workspace GET/sendersConnected senders POST/workspace/outreach/pausePause all outreach POST/workspace/outreach/resumeResume outreach PATCH/workspaceChange the workspace's settings