Skip to content
Revenue API
/
/
Edit one POB of a contrac...

Edit one POB of a contract

Request

Purpose

Updates the name, POB template, template version, expiry date, and lead line of one performance obligation (POB).

When to use

  • Reassign one POB to a different POB template or correct its attributes.

Behavior notes

Errors from the revenue engine for this operation are returned as HTTP 200 with success: false and the generic message shown in the examples, not as 4xx/5xx responses.

Security
bearerAuth
Path
rcIdinteger, (int64)required

Revenue contract ID.

Example:111442
pobIdinteger, (int64)required

Performance obligation (POB) ID.

Example:156912
Headers
X-REV-BOOK-IDinteger, (int64)

Revenue book to work in. Defaults to 1 (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books.

Default:1
Example:1
Zuora-Request-Idstring, <= 64 characters

Optional correlation ID, echoed in the traceId response header.

Example:b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11
Bodyapplication/jsonrequired
namestringrequired

POB name.

pobTemplateIdinteger, (int64)required

POB template ID that defines the recognition rules.

pobVersioninteger, (int64)required

Version of the POB template.

expiryDatestringrequired

POB expiry date (yyyy-MM-dd).

Example:"2026-12-31"
leadLineIdinteger, (int64)required

Line that acts as the lead line of the POB.

commentsstringrequired

Reason for the edit. Can be empty but must be present.

objectVersioninteger, (int32)

Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.

Example:5
{
  "name": "Annual Support",
  "pobTemplateId": 100,
  "pobVersion": 2,
  "expiryDate": "2026-12-31",
  "leadLineId": 85922,
  "comments": "Updating POB attributes"
}

Responses

Processed. success: true means the action completed; success: false means a business rule rejected it and message explains why.

Headers
traceIdstring

Correlation ID of the request. Quote it when you contact Zuora Global Support.

Bodyapplication/json
successbooleanrequired

true when the action completed. false when the revenue engine rejected it under a business rule; see message.

processIdstringrequired

Unique ID generated for this request. Quote it when you contact Zuora Global Support.

messagestring

Result message from the revenue engine. May be empty on success.

changeIdsstring

Comma-separated IDs of records changed by the action, when the action reports them. Omitted otherwise.

Response
{
  "success": true,
  "processId": "3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11",
  "message": "POB attributes updated successfully"
}