curl --request PATCH \
  --url https://api.xplenty.com/{account_id}/api/packages/{package_id}/variables \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variables": {
    "region": "us-east-1",
    "batch_size": "500"
  }
}
'

{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "variables": {},
  "owner_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "html_url": "<string>",
  "status": "<string>",
  "missing_secret_variables": [
    "<string>"
  ]
}

{
  "message": "Item not found."
}

{
  "message": "Item not found."
}

{
  "message": "Item not found."
}

{
  "message": "Item not found."
}

Packages

Update Package Variables

Updates only the variables and secret_variables of the specified package. Other package fields, including name, description, and data_flow_json, are not touched even if sent in the request body.

Use this endpoint when you want to save variable changes without persisting any unsaved canvas edits on the package. For full package updates, use PUT /packages/{package_id} instead.

variables replaces the existing variables map. secret_variables is merged into the existing secrets: a null value deletes that secret key, and any other value adds or replaces it.

A secret value shorter than 6 characters, or a variable with an empty name, returns 400. Sending null for the whole secret_variables field, or a package that fails validation, returns 422.

PATCH

packages

{package_id}

variables

curl --request PATCH \
  --url https://api.xplenty.com/{account_id}/api/packages/{package_id}/variables \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "variables": {
    "region": "us-east-1",
    "batch_size": "500"
  }
}
'

{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "variables": {},
  "owner_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "html_url": "<string>",
  "status": "<string>",
  "missing_secret_variables": [
    "<string>"
  ]
}

{
  "message": "Item not found."
}

{
  "message": "Item not found."
}

{
  "message": "Item not found."
}

{
  "message": "Item not found."
}

Authorizations

Authorization

string

header

required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

string

default:application/vnd.xplenty+json; version=2

required

API version header — required on all requests

Path Parameters

package_id

integer

required

The unique ID of the package

Body

application/json

Partial update payload for the variables-only endpoint. Only variables and secret_variables are accepted; any other fields are ignored.

variables

object

Package variables. Replaces the package's existing variables. Omit to leave them unchanged. Send {} to clear them.

secret_variables

object

Secret variables as key-value pairs, merged into the existing secrets. Values of DUMMY_KEY or masked values are ignored. A key with a null value deletes that secret. Any other value must be a string of at least 6 characters. Sending null for the whole field returns a 422 error.

Show child attributes

Response

Package variables updated

integer

name

string

description

string

variables

object

owner_id

integer

created_at

string<date-time>

updated_at

string<date-time>

url

string<uri>

html_url

string<uri>

status

string

missing_secret_variables

string[]

Returned on create or update when the request referenced secret variables with placeholder values that the package has no value for. Set these secrets before running the package. Present only when at least one secret is missing.

Clusters

Jobs

Packages

Package Validations

Schedules

Deliveries

Connections

Connection Groups

Accounts

Members

Users

Public Keys

Notifications

Hooks

System

Billing

Update Package Variables

Authorizations

Headers

Path Parameters

Body

Response