Configure Partner Profile

post/api/partner-profiles/{accountId}/configure

Update the partner profile configuration for a specific account. Different attributes may require different authorization levels.

Request

Path Parameters

accountIdstring<uuid>required
The unique identifier of the partner account

Body application/json

attributeNamestringrequired
Allowed values:logoUrlsupportEmailsupportUrlemail.kycConfirmation.successBanner.urlemail.xpayConfirmation.applePayBanner.urlemail.xpayConfirmation.googlePayBanner.urlemail.kycConfirmation.cardActivation.urlemail.kyc.enabled
Configuration attribute name
attributeValuestring | boolean | nullrequired
Configuration attribute value (string or boolean)
One of

Response

Partner profile configuration updated successfully.

Request parameters are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

User is not allowed to perform the action.

FORBIDDEN Insufficient permissions to perform the action.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://api.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://api.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://api.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://test.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://test.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://test.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

curl 'https://test.immersve.com/api/partner-profiles/{accountId}/configure' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "attributeName": "email.kyc.enabled",
  "attributeValue": true
}'

Example Response

No response body.

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}