Skip to content

Update Program Metadata

POST /rest/asset/v1/program/{id}.json

Permissions Read-Write Assets

Build a request and mock the response

Method: POST
Path: /rest/asset/v1/program/{id}.json
Tag: Programs
Operation ID: updateProgramUsingPOST

Updates the target program's metadata. The channel may be updated after creation; doing so keeps Program Settings Channel and the Channel tag in sync, and is rejected if a child campaign uses a Change Program Status flow step. The type may only be set at creation. Required Permissions: Read-Write Assets

Formats

  • Request: application/x-www-form-urlencoded
  • Response: application/json

Request

Path parameters

Name Type Required Description Constraints
id integer (int32) Yes id

Request body

Name: updateProgramRequest
Required: Yes
Schema: model: UpdateProgramRequest

updateProgramRequest

Generated example

{
  "channel": "string",
  "costs": [
    {
      "cost": 123,
      "note": "string",
      "startDate": "2026-01-15T10:30:00Z"
    }
  ],
  "costsDestructiveUpdate": true,
  "description": "string",
  "endDate": "string",
  "name": "Example name",
  "startDate": "string",
  "tags": [
    {
      "tagType": "string",
      "tagValue": "string"
    }
  ]
}

Referenced models

Example request

POST {{base_url}}/rest/asset/v1/program/{{id}}.json
Content-Type: application/x-www-form-urlencoded
Accept: application/json

{
  "channel": "string",
  "costs": [
    {
      "cost": 123,
      "note": "string",
      "startDate": "2026-01-15T10:30:00Z"
    }
  ],
  "costsDestructiveUpdate": true,
  "description": "string",
  "endDate": "string",
  "name": "Example name",
  "startDate": "string",
  "tags": [
    {
      "tagType": "string",
      "tagValue": "string"
    }
  ]
}

Responses

200 — OK

Schema: model: ResponseOfProgramResponse

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "channel": "string",
      "costs": [
        {
          "cost": 123,
          "note": "string",
          "startDate": "2026-01-15T10:30:00Z"
        }
      ],
      "createdAt": "2026-01-15T10:30:00Z",
      "description": "string",
      "endDate": "2026-01-15T10:30:00Z",
      "folder": {
        "id": 123,
        "type": "Folder"
      },
      "id": 123,
      "name": "Example name",
      "sfdcId": "123",
      "sfdcName": "Example name",
      "startDate": "2026-01-15T10:30:00Z",
      "status": "locked",
      "tags": [
        {
          "tagType": "string",
          "tagValue": "string"
        }
      ],
      "type": "default",
      "updatedAt": "2026-01-15T10:30:00Z",
      "url": "https://example.com",
      "workspace": "string"
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models

Source

Generated from swagger-asset.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.