Skip to content

Area: Developers

PUT

Update, pause or resume a shop

Path
/partners/domains
Auth
Partner token · partner server only
PUT
/partners/domains
Code sample: cURL
# $SIGNED_PAYLOAD: the request claims as a JWT signed with your private key, see https://releva.ai/documentation/reference/partners/overview/#authentication
curl --request PUT \
--url 'https://releva.ai/api/v0/partners/domains' \
--header 'content-type: application/json' \
--header "x-rlv-partner-token: $RELEVA_PARTNER_TOKEN" \
--data "{\"payload\": \"$SIGNED_PAYLOAD\"}"

Changes settings of a shop this partner provisioned. Only the listed fields are applied; fields you leave out keep their value. running: false pauses the shop (tracking, personalization and messaging stop, so no usage accrues); running: true resumes it. unsubscribeLink is validated only when it changes. Sending appEmbedActive makes the server record the check time in appEmbedCheckedAt. A changed dynamicPriceCapUSD lifts a usage-limit suspension immediately when the current period is under the new cap.

Media typeapplication/json
object
payload
required

The request fields as JWT claims, signed with your RSA private key (RS512 recommended; RS256/384 and PS256/384/512 are also accepted) with a short expiry (expiresIn: '1h'). The operation’s x-signed-claims schema lists the claims.

string

Example generated

{
"payload": "example"
}

Updated. The response is the domain with its account.

Media typeapplication/json
object
domain
required

The shop’s full domain record (about 100 fields; only the ones partners need are listed). On PUT and uninstall it also contains account.

object
id
required
integer
accountId
required
integer
name
required
string
url
required
string
accessToken
required

Public token for the browser and the SDKs.

string format: uuid
secretKey
required

Secret key for server-to-server calls. Keep it on your server.

string format: uuid
platform
string
currency
string
locale
string
running
boolean
runningSuspendedReason
string | null
integrationActive
boolean | null
appEmbedActive
boolean | null
appEmbedCheckedAt
string | null format: date-time
disabledServices
Array<string>
productSyncApiUrl
string | null
subscriberSyncApiUrl
string | null
dynamicPriceCapUSD
number | string | null
fixedPriceAmountUSD
number | string | null
pages

Returned by POST only. Store token by name for the standard integration.

Array<object>
object
name
string
token
string
key
additional properties
any

Example

{
"domain": {
"url": "https://demo-partner-shop.example.com",
"runningSuspendedReason": "appUninstalled",
"disabledServices": [
"email",
"textMessage"
]
}
}

Partner token, shop lookup or unsubscribe link error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Examples

{
"message": "Domain with url unknown-shop.example.com cannot be found or you don't have access to it."
}

A value failed model validation.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "Validation error! Validation is In on product Sync Type failed"
}

The payload could not be verified (missing, not a JWT, signed with another key, or expired), or another unexpected error.

Media typeapplication/json
object
message
required

Human-readable error. Several validation errors are joined with a space.

string

Example

{
"message": "An internal error occurred."
}