Skip to content

Area: Developers

POST

Provision a shop

Path
/partners/domains
Auth
Partner token · partner server only
POST
/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 POST \
--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\"}"

Creates the merchant’s account and domain, or updates them if this partner already provisioned the same name and url. The account is found by name (account names are unique across Releva) and the domain by url within that account: sending a different name for an existing shop creates a second account and domain, so always send the exact name you used first. url is stored as https://<host> (protocol and trailing slash are removed first). A new domain starts with email and SMS sending disabled, subscription management internal and quiet hours 22:00 to 09:00 in timezoneOffset. Save domain.accessToken, domain.secretKey and the page tokens (domain.pages[].token by name) for the standard integration.

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"
}

The shop already existed for this partner and was updated.

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"
]
}
}

Account and domain were created.

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 field or validation error.

Media typeapplication/json
object
message
required

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

string

Examples

{
"message": "Partner identification is missing!"
}

Request body larger than 800 KB.

Media typeapplication/json
object
message
required

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

string

Example

{
"message": "request entity too large"
}

The account name belongs to an account that is not yours.

Media typeapplication/json
object
message
required

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

string

Example

{
"message": "An account named \"Demo Partner Internal Shop (demo-partner-internal.example.com)\" already exists. Account names are unique across Releva - send a name that includes the shop domain."
}

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."
}