Settings configuration

For each RequestType is possible to manage some default settings, the settings are called requestSettingsDefault.

requestSettingsDefault UPDATE

Endpoint

• URL: /requestType/{id}/settings

• Method: PUT

Headers

Ensure you include the following headers in your request:

• Accept: application/json

• Content-Type: application/json

• X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Path parameters

• requestSettingsDefault (required): here is possible to set the default setting properties of the target requestType:

  • wizardUrlBack: url to redirect the user when the process is complete.
    Placehoders:

    • <requestId>

    • <referenceId>

    • <status>: final status of the request

    • <requestTypeId>

    • <actor>: is the role of the customer in the Namirial Onboarding process, usually userToIdentify

Example cURL API call

curl --request PUT \
  --url https://test.onboarding.namirial.app/api/v2/requestType/eebcb3ed-6872-4f57-a550-52890af35a10/settings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'content-type: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --data '{
    "requestSettingsDefault": {
        "wizardUrlBack": "https://webhook.site/2c47164f-fc65-44cd-a8c4-a2c806fb6c8a?requestId=<requestId>&referenceId=<referenceId>&status=<status>&requestTypeId=<requestTypeId>&actor=<actor>"
    }
}'

⬇️ requestSettingsDefault GET

Endpoint

• URL: /requestType/{id}/settings

• Method: GET

Headers

Ensure you include the following headers in your request:

• Accept: application/json

• Content-Type: application/json

• X-Api-Key: YOUR_API_KEY (replace YOUR_API_KEY with your actual API key)

Example cURL API call

curl --request GET \
  --url https://test.onboarding.namirial.app/api/v2/requestType/eebcb3ed-6872-4f57-a550-52890af35a10/settings \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'content-type: application/json'