Update a site

PATCHhttps://api.norreach.app/v1/sites/{id}

The company details every page shows (legal), the look (theme) and the default language. Ad pixels are chosen in the app (they need a connected ad account).

pages:writeRole must allow: pages.editOperation id: update_site

PATCH/sites/{id}

curl -X PATCH "https://api.norreach.app/v1/sites/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "legal": {
    "company_name": "Acme Staffing AB",
    "email": "hello@acme.example"
  }
}'

Update a site

{
  "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "object": "site",
  "name": "Acme Staffing",
  "subdomain": "acme",
  "primary_host": "acme.norreach.page",
  "default_language": "sv",
  "status": "active",
  "legal": {
    "company_name": "Acme Staffing AB"
  },
  "theme": {},
  "domains": []
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope pages: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

legalobject

Show child attributes

legal.company_namestringrequired

legal.org_numberstring

legal.addressstring

legal.emailstring

legal.phonestring

legal.hoursstring

legal.privacy_urlstring

legal.terms_urlstring

themeobject

default_languageenum

One of:ensv

Response

200application/json— Update a site

idstring (uuid)required

An id (UUID).

object"site"required

namestringrequired

subdomainstringrequired

primary_hoststringrequired

Where the site's pages are served.

default_languageenumrequired

One of:ensv

statusstringrequired

legalobjectrequired

The company details every page shows.

themeobjectrequired

domainsobject[]required

Show child attributes

domains[].idstring (uuid)required

An id (UUID).

domains[].object"domain"required

domains[].hostnamestringrequired

domains[].statusstringrequired

Where setting it up has got to (e.g. pending, active, misconfigured).

domains[].is_primarybooleanrequired

domains[].redirect_tostring | nullrequired

domains[].recordsanyrequired

The DNS records to set at your domain's provider.

domains[].last_errorstring | nullrequired

domains[].last_checked_atstring | nullrequired

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.
403	`role_forbidden`	The key's creator's role can't do this.
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.

PATCH/sites/{id}

curl -X PATCH "https://api.norreach.app/v1/sites/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "legal": {
    "company_name": "Acme Staffing AB",
    "email": "hello@acme.example"
  }
}'

Update a site

{
  "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "object": "site",
  "name": "Acme Staffing",
  "subdomain": "acme",
  "primary_host": "acme.norreach.page",
  "default_language": "sv",
  "status": "active",
  "legal": {
    "company_name": "Acme Staffing AB"
  },
  "theme": {},
  "domains": []
}