Partially update a custom object record

Updates one or many fields of a custom object record. Patch update uses JSON Merge Patch as specified in RFC 7386.

Limitations

  • The storage of empty strings in records is not supported.
  • Null values must be formatted as the following example:
    {
  "records": [
    {
      "fieldName__c": null
    }
  ]
}
  • When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications.
    If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization.
Request
path Parameters
object
required
string

Specifies the custom object's API name as object. It is case-sensitive.

id
required
string <uuid> = 36 characters

Id identifier in uuid form

header Parameters
Authorization
required
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Version
string <date>

API version that determines the response schema. The default version is used if this parameter is not included. Specify Zuora-Version in the request header if you expect a specific response schema.

Request Body schema: application/merge-patch+json
required
property name*
additional property
any

The field-value pairs for a custom object record

Responses
200

OK

404

Object record does not exist

patch/objects/records/default/{object}/{id}
Request samples
application/merge-patch+json
{
  • "age__c": 32,
  • "email__c": "smith123@example.com",
  • "home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
  • "last_name__c": "Smith",
  • "marital_status__c": "Married",
  • "work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714"
}
Response samples
application/json
{
  • "CreatedById": "58bcc694-0b01-4c38-83d9-679891aee4dc",
  • "CreatedDate": "2017-06-07T17:26:47.501Z",
  • "Id": "f4f3d0a8-9d45-43d6-956c-4820f2de7559",
  • "UpdatedById": "58bcc694-0b01-4c38-83d9-679891aee4dc",
  • "UpdatedDate": "2017-06-07T17:26:47.501Z",
  • "age__c": 32,
  • "email__c": "smith123@example.com",
  • "home_address__c": "59b38ad1-27d4-40e8-af66-8c138bc382ee",
  • "last_name__c": "Smith",
  • "marital_status__c": "Married",
  • "type": "person",
  • "version": 1,
  • "work_address__c": "8a19f16a-2b5e-4a26-bb20-c79cd6984714"
}