Skip to content

Area: Developers

POST

Create or update profiles for a shop

Path
/partners/domains/profiles
Auth
Partner token · partner server only
POST
/partners/domains/profiles
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/profiles' \
--header 'content-type: application/json' \
--header "x-rlv-partner-token: $RELEVA_PARTNER_TOKEN" \
--data "{\"payload\": \"$SIGNED_PAYLOAD\"}"

Same behaviour as POST /profiles, for a shop you provisioned. Entries without id, email or phoneNumber are skipped; the request fails only if no entry is left. Processed asynchronously.

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

Accepted for asynchronous processing.

Media typeapplication/json
object
0

Example

{}

Validation, partner token or shop lookup error.

Media typeapplication/json
object
message
required

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

string

Examples

{
"message": "The 'profiles' field is required."
}

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