Set the lawful basis

PUThttps://api.norreach.app/v1/contacts/{id}/consent

Records the lawful basis for contacting this person (basis: null clears it — nothing is sent to them after that). Recording a basis lets sequences that were waiting for one carry on, exactly as setting it in the app does.

contacts:writeOperation id: set_contact_consent

PUT/contacts/{id}/consent

curl -X PUT "https://api.norreach.app/v1/contacts/{id}/consent" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "basis": "consent",
  "source": "double_opt_in"
}'

Set the lawful basis

{
  "id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "object": "contact",
  "first_name": "Maja",
  "last_name": "Lind",
  "email": "maja.lind@example.com",
  "phone": "+46701234567",
  "company": "Example Care AB",
  "title": "Head of Staffing",
  "status": "new",
  "stage": "new",
  "tags": [
    "webinar"
  ],
  "source": "api",
  "assigned_to": null,
  "timezone": "Europe/Stockholm",
  "linkedin_url": null,
  "fit_score": null,
  "consent": {
    "basis": "consent",
    "source": "webinar_signup",
    "recorded_at": "2026-11-04T09:12:33.120Z"
  },
  "attrs": {
    "crm_id": "C-1042"
  },
  "created_at": "2026-11-04T09:12:33.120Z",
  "updated_at": "2026-11-04T09:12:33.120Z"
}

Authorizations

Authorizationstringheaderrequired

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

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Headers

Idempotency-Keystringheader

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

Body

application/json

basisenum | nullrequired

sourcestring

Response

200application/json— Set the lawful basis

idstring (uuid)required

An id (UUID).

object"contact"required

first_namestringrequired

last_namestringrequired

emailstring | nullrequired

phonestring | nullrequired

E.164, e.g. +46701234567.

companystring | nullrequired

titlestring | nullrequired

statusstringrequired

One of: new, contacted, interested, not_interested, converted, meeting_booked, bad_data, bad_timing, neutral, unresponsive, unqualified, dnc.

stagestring | nullrequired

Pipeline stage — one of: new, contacted, meeting, qualified, won, lost.

tagsstring[]required

sourcestring | nullrequired

Where the contact came from (api for contacts created through the API).

assigned_tostring (uuid) | nullrequired

The member who owns this contact.

timezonestring | nullrequired

IANA time zone — quiet hours follow it.

linkedin_urlstring | nullrequired

fit_scorenumber | nullrequired

consentobject | nullrequired

attrsobjectrequired

Your own fields (free-form JSON, at most 16 KB).

created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

updated_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

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.
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.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
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.

PUT/contacts/{id}/consent

curl -X PUT "https://api.norreach.app/v1/contacts/{id}/consent" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "basis": "consent",
  "source": "double_opt_in"
}'

Set the lawful basis

{
  "id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "object": "contact",
  "first_name": "Maja",
  "last_name": "Lind",
  "email": "maja.lind@example.com",
  "phone": "+46701234567",
  "company": "Example Care AB",
  "title": "Head of Staffing",
  "status": "new",
  "stage": "new",
  "tags": [
    "webinar"
  ],
  "source": "api",
  "assigned_to": null,
  "timezone": "Europe/Stockholm",
  "linkedin_url": null,
  "fit_score": null,
  "consent": {
    "basis": "consent",
    "source": "webinar_signup",
    "recorded_at": "2026-11-04T09:12:33.120Z"
  },
  "attrs": {
    "crm_id": "C-1042"
  },
  "created_at": "2026-11-04T09:12:33.120Z",
  "updated_at": "2026-11-04T09:12:33.120Z"
}