Update Source Settings

puthttps://api.flxpoint.com/source/{sourceId}/settings

Use this when you want to replace source data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

This endpoint configures Source Settings.

You must specify either a `handle` or `settingId` to associate settings.

If a passed setting has not been configured yet, this will associate a `value` (i.e. configure that setting).

If a passed setting has already been configured, this will overwrite the previous `value`.

Request

Bodyapplication/json

array[PutSourceSetting]

valuestringrequired

The `value` of a `Setting`

handlestring

The handle of a `Setting`

settingIdinteger

The `Setting` ID

Example request

put/source/{sourceId}/settings

curl -X PUT "https://api.flxpoint.com/source/{sourceId}/settings" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
         {
           "value": "string",
           "handle": "string",
           "settingId": 0
         }
       ]'

Example body · application/json

[
  {
    "value": "string",
    "handle": "string",
    "settingId": 0
  }
]

Responses

200OK

No schema documented for this status.

401Unauthorized

No schema documented for this status.

OpenAPI fragment

{
  "put": {
    "summary": "Update Source Settings",
    "description": "This endpoint configures Source Settings. \n\nYou must specify either a `handle` or `settingId` to associate settings. \n\nIf a passed setting has not been configured yet, this will associate a `value` (i.e. configure that setting). \n\nIf a passed setting has already been configured, this will overwrite the previous `value`. ",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PutSourceSetting"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK"
      },
      "401": {
        "description": "Unauthorized"
      }
    }
  }
}

Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight