Skip to main content
PATCH
Update Website

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

website_id
string<uuid>
required

The unique identifier of the website

Body

application/json

Request body for updating a website. external_id is required; unknown fields are rejected with 400.

external_id
string | null
required

Partner-only. Partner-supplied identifier to attach to this website. Pass a non-empty string to set or replace the mapping, or null to clear an existing mapping. Surrounding whitespace is trimmed; a blank value or one longer than 255 characters returns 400. Accepted only when authenticating with an API key for an organization flagged as a partner. Sending this field as a direct customer returns 403 Forbidden. Must be unique per resource type within your organization: setting a value already used by another website returns 409 with the existing website in the payload.

Required string length: 1 - 255
Example:

"ws_a7f3b2c9"

Response

Mapping updated. externalId is always present on this response: the new value, or null after a clear. Like the external_id lookup responses, and unlike the GET /api/v1/websites listing, this endpoint does not return baseCountry.

website
object
required