Invite someone

POSThttps://api.norreach.app/v1/invites

Emails an invitation to join the workspace as role (default caller; never owner, never above the key creator's own role). Owners, admins and managers; inviting a manager or an admin is a role decision, so it also needs an owner or admin AND the team:admin scope. Someone already in the workspace only gets the email again (their role is unchanged); an email that belongs to another workspace → 409 conflict. It emails a person, so an Idempotency-Key is required and dry_run=true previews it. At most 20 invitations an hour per workspace (and 5 a minute per key) → 429. The outreach pause doesn't apply (it isn't outreach).

team:writeRole must allow: team.inviteIdempotency-Key requiredSupports dry_runOperation id: create_invite

POST/invites

curl -X POST "https://api.norreach.app/v1/invites" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "sam@acme.example",
  "name": "Sam Berg",
  "role": "caller"
}'

Invite someone

{
  "id": "7c6b5a49-3827-4615-8a4b-3c2d1e0f9a8b",
  "object": "invite",
  "email": "sam@acme.example",
  "name": "Sam Berg",
  "role": "caller",
  "status": "sent",
  "dry_run": false,
  "note": "Invitation sent. They join with this role when they accept it."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope team:write. API keys and scopes

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheaderrequired

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

emailstring (email)required

Who to invite.

namestring

Their name, for the email and the member list.

roleenum

The role to give: caller, manager or admin (never owner).

One of:callermanageradmin

Response

201application/json— Invite someone

idstring (uuid) | nullrequired

The invited person's member id (null on a dry run for someone new).

object"invite"required

emailstringrequired

namestring | nullrequired

roleenumrequired

The role they have — for someone already in the workspace, their own (an invite never changes it).

One of:owneradminmanagercaller

statusenumrequired

resent = they were already in the workspace: only the email went out again.

One of:sentresentdry_run

dry_runbooleanrequired

notestringrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
400	`idempotency_key_required`	This operation needs an Idempotency-Key header.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
409	`conflict`	That conflicts with the current state.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/invites

curl -X POST "https://api.norreach.app/v1/invites" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "sam@acme.example",
  "name": "Sam Berg",
  "role": "caller"
}'

Invite someone

{
  "id": "7c6b5a49-3827-4615-8a4b-3c2d1e0f9a8b",
  "object": "invite",
  "email": "sam@acme.example",
  "name": "Sam Berg",
  "role": "caller",
  "status": "sent",
  "dry_run": false,
  "note": "Invitation sent. They join with this role when they accept it."
}