Upgrade a managed transform
POST/v1/transforms/{transformId}/upgradepreview
Pin the transform to another version of its managed transform, the newest unless you name one. Every source linking it builds events with that version from then on. Refused with 400 for a version PayloadPuffin doesn’t have, and with 409 when the transform isn’t pinned.
Path parameters
transformIdstring RequiredA transform ID, starting with tfm_.
Body
versioninteger OptionalThe version to pin. Omitted: the newest version.
At least 1
Returns
The command completed.200
dataobject RequiredCode that destinations or sources link: one saved draft and the one live code, or a managed pin.
idstring RequiredA transform ID, starting with tfm_.
kindstring Requireddestination: maps an event payload to the request a destination receives. source: builds an event from the request a source receives. A transform links only to resources of its kind.
Allowed values: "destination", "source"
namestring RequiredA name for people.
1 to 120 characters
managedobject | null RequiredThe managed transform version this transform runs in place of code of its own.
draftobject | null RequiredThe saved draft. Saving it changes nothing until it is published. Null when pinned.
liveobject | null RequiredThe published code every linked destination and source runs. Null until the draft is first published, or when pinned.
unpublishedChangesboolean RequiredTrue when the draft is not the live code: it was never published, or it was saved since.
destinationsobject[] RequiredThe destinations that link this transform, by name.
Show child attributesHide child attributes
idstring RequiredA destination ID, starting with dst_.
namestring RequiredIts name.
sourcesobject[] RequiredThe sources that link this transform, by name.
Show child attributesHide child attributes
idstring RequiredA source ID, starting with src_.
namestring RequiredIts name.
createdAtstring (date-time) RequiredISO 8601 timestamp.
updatedAtstring (date-time) RequiredISO 8601 timestamp.
Example
curl -X POST "https://api.payloadpuffin.com/v1/transforms/$TRANSFORMID/upgrade" \
-H "Authorization: Bearer $PAYLOADPUFFIN_API_KEY" \
-H 'Content-Type: application/json' \
-d '{}'{
"data": {
"id": "id",
"kind": "destination",
"name": "name",
"managed": {
"provider": "provider",
"version": 1
},
"draft": {
"code": "code",
"savedAt": "savedAt"
},
"live": {
"code": "code",
"publishedAt": "publishedAt"
},
"unpublishedChanges": true,
"destinations": [
{
"id": "id",
"name": "name"
}
],
"sources": [
{
"id": "id",
"name": "name"
}
],
"createdAt": "createdAt",
"updatedAt": "updatedAt"
}
}Errors
Errors use application/problem+json. The code member is stable; branch on it rather than on title or detail.
4XXapplication/problem+jsonThe request was rejected.