Skip to main content
POST
/
merlin
/
config
Configure FTP credentials for Merlin addon
curl --request POST \
  --url https://api.royalti.io/merlin/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {
    "host": "ftp.merlin.com",
    "port": 21,
    "username": "user@merlin.com",
    "password": "<string>",
    "secure": true,
    "passiveMode": true,
    "timeout": 30000
  },
  "features": {
    "royaltyImport": true
  }
}
'
import requests

url = "https://api.royalti.io/merlin/config"

payload = {
"credentials": {
"host": "ftp.merlin.com",
"port": 21,
"username": "user@merlin.com",
"password": "<string>",
"secure": True,
"passiveMode": True,
"timeout": 30000
},
"features": { "royaltyImport": True }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
credentials: {
host: 'ftp.merlin.com',
port: 21,
username: 'user@merlin.com',
password: '<string>',
secure: true,
passiveMode: true,
timeout: 30000
},
features: {royaltyImport: true}
})
};

fetch('https://api.royalti.io/merlin/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.royalti.io/merlin/config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'credentials' => [
'host' => 'ftp.merlin.com',
'port' => 21,
'username' => 'user@merlin.com',
'password' => '<string>',
'secure' => true,
'passiveMode' => true,
'timeout' => 30000
],
'features' => [
'royaltyImport' => true
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.royalti.io/merlin/config"

payload := strings.NewReader("{\n \"credentials\": {\n \"host\": \"ftp.merlin.com\",\n \"port\": 21,\n \"username\": \"user@merlin.com\",\n \"password\": \"<string>\",\n \"secure\": true,\n \"passiveMode\": true,\n \"timeout\": 30000\n },\n \"features\": {\n \"royaltyImport\": true\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/merlin/config")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"credentials\": {\n \"host\": \"ftp.merlin.com\",\n \"port\": 21,\n \"username\": \"user@merlin.com\",\n \"password\": \"<string>\",\n \"secure\": true,\n \"passiveMode\": true,\n \"timeout\": 30000\n },\n \"features\": {\n \"royaltyImport\": true\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/merlin/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"credentials\": {\n \"host\": \"ftp.merlin.com\",\n \"port\": 21,\n \"username\": \"user@merlin.com\",\n \"password\": \"<string>\",\n \"secure\": true,\n \"passiveMode\": true,\n \"timeout\": 30000\n },\n \"features\": {\n \"royaltyImport\": true\n }\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "data": {
    "autoImportEnabled": true,
    "importSchedule": "0 6 * * *",
    "importPath": "/royalties",
    "royaltySourceId": 123,
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "royaltySourceName": "<string>",
    "autoApproveHighConfidence": false,
    "confidenceThreshold": 0.75,
    "scheduleTime": "06:00",
    "timezone": "America/New_York",
    "dayOfWeek": 3,
    "dayOfMonth": 16,
    "blackoutWindows": [
      {
        "startTime": "<string>",
        "endTime": "<string>"
      }
    ],
    "lastImportAt": "2023-11-07T05:31:56Z",
    "nextScheduledImport": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"status": "error",
"message": "Invalid request parameters"
}
{
"status": "error",
"message": "Unauthorized"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Code Examples

const response = await fetch('https://api.royalti.io/merlin/config', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "features": {
      "royaltyImport": true
    }
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/merlin/config',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"features":{"royaltyImport":true}}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/merlin/config \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"features":{"royaltyImport":true}}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
credentials
object
required
features
object

Response

Configuration stored successfully

success
boolean
data
object