Skip to main content
POST
/
ddex
/
tenant-providers
Create tenant provider configuration
curl --request POST \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/ddex/tenant-providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "providerId": "<string>",
  "labelId": "<string>",
  "deliveryMethod": "SFTP",
  "credentials": {},
  "customSettings": {},
  "priority": 123,
  "rateLimits": {},
  "acknowledgementSettings": {}
}'
{
  "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,
    "deliveryMethod": "SFTP",
    "priority": 123,
    "customSettings": {},
    "rateLimits": {},
    "acknowledgementSettings": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

​
Code Examples

const response = await fetch('https://server26-dot-royalti-project.uc.r.appspot.com/ddex/tenant-providers', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "providerId": "sample-providerId",
    "labelId": "sample-labelId",
    "deliveryMethod": "sample-deliveryMethod",
    "credentials": {},
    "customSettings": {},
    "priority": 1,
    "rateLimits": {},
    "acknowledgementSettings": {}
  })
});

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

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
providerId
string
required
​
deliveryMethod
enum<string>
required
Available options:
SFTP,
WebService,
API
​
credentials
object
required
​
labelId
string | null
​
customSettings
object
​
priority
integer
​
rateLimits
object
​
acknowledgementSettings
object

Response

Created

​
status
string
​
data
object