Update tenant provider configuration

curl --request PUT \
  --url https://api.royalti.io/ddex/tenant-providers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {
    "host": "new-ftp.provider.com",
    "username": "newuser",
    "password": "newpassword"
  }
}
'

{
  "status": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantId": 123,
    "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "LabelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isEnabled": true,
    "priority": 123,
    "customSettings": {},
    "rateLimits": {},
    "acknowledgementSettings": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "Invalid request parameters"
}

{
  "status": "error",
  "message": "Unauthorized"
}

{
  "status": "error",
  "message": "Resource not found"
}

{
  "status": "error",
  "message": "Internal server error"
}

PUT

ddex

tenant-providers

{id}

curl --request PUT \
  --url https://api.royalti.io/ddex/tenant-providers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "credentials": {
    "host": "new-ftp.provider.com",
    "username": "newuser",
    "password": "newpassword"
  }
}
'

{
  "status": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "TenantId": 123,
    "providerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "LabelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isEnabled": true,
    "priority": 123,
    "customSettings": {},
    "rateLimits": {},
    "acknowledgementSettings": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "status": "error",
  "message": "Invalid request parameters"
}

{
  "status": "error",
  "message": "Unauthorized"
}

{
  "status": "error",
  "message": "Resource not found"
}

{
  "status": "error",
  "message": "Internal server error"
}

Description

All fields are optional - only provided fields will be updated. Updating credentials will automatically invalidate the adapter cache. See POST endpoint for credential schema details. Authorization:

Required role: owner only

Code Examples

const response = await fetch('https://api.royalti.io/ddex/tenant-providers/example-id', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "deliveryMethod": "sample-deliveryMethod",
    "customSettings": {},
    "priority": 1,
    "rateLimits": {},
    "acknowledgementSettings": {},
    "isEnabled": true
  })
});

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

import requests

response = requests.put(
  'https://api.royalti.io/ddex/tenant-providers/example-id',
  json={"deliveryMethod":"sample-deliveryMethod","customSettings":{},"priority":1,"rateLimits":{},"acknowledgementSettings":{},"isEnabled":true}
)

data = response.json()
print(data)

curl -X PUT https://api.royalti.io/ddex/tenant-providers/example-id \
  -H "Content-Type: application/json" \
  -d '{"deliveryMethod":"sample-deliveryMethod","customSettings":{},"priority":1,"rateLimits":{},"acknowledgementSettings":{},"isEnabled":true}'

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Tenant provider configuration ID

Body

application/json

deliveryMethod

enum<string>

Delivery protocol to use

Available options:

SFTP,

FTP,

HTTP,

HTTPS,

AS2,

WebDAV

credentials

object

Credentials for SFTP/FTP delivery method

Option 1
Option 2
Option 3
Option 4

Show child attributes

customSettings

object

Provider-specific custom settings

priority

integer

Priority for this provider (higher = preferred)

rateLimits

object

Rate limiting configuration

acknowledgementSettings

object

MDN/acknowledgement settings

isEnabled

boolean

Enable or disable this provider configuration

Response

Success

status

string

data

object

Show child attributes

​Description

​Code Examples

Authorizations

Path Parameters

Body

Response

Description

Code Examples