Update a callout template

PUT

/notifications/callout-templates/:id

PUT

/notifications/callout-templates/:id

from zuora import ZuoraClient, PutPublicCalloutTemplateRequestCommon
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.notifications.update_callout_template(
    id="id",
    request=PutPublicCalloutTemplateRequestCommon(
        callout_baseurl="https://www.example.com/callout/AccountEdit",
        http_method="POST",
        name="Account Edit",
    ),
)

{
  "active": true,
  "calloutBaseurl": "https://www.example.com/callout/AccountEdit",
  "calloutHeaders": null,
  "calloutParams": null,
  "calloutRetry": true,
  "certificate": null,
  "confirmSuccessFromResponseContent": false,
  "contentType": "APPLICATION_JSON",
  "createdBy": "8a90e08282f4ed040182f67bab2902ff",
  "createdOn": "2024-06-17T04:07:13.000 UTC",
  "customRequestBody": null,
  "description": "Callout when an account is edited",
  "eventTypeName": "AccountEdit",
  "eventTypeNamespace": "user.notification",
  "hmacAlgorithm": null,
  "hmacData": null,
  "hmacKey": null,
  "hmacOutputFormat": null,
  "hmacSecret": null,
  "hmacValue": null,
  "httpMethod": "POST",
  "id": "dcc5a61ee76e496c984206131b5b83e7",
  "name": "Account Edit",
  "oauth2ProviderId": null,
  "requiredAuth": false,
  "requiredOauth2": false,
  "updatedBy": "8a90e08282f4ed040182f67bab2902ff",
  "updatedOn": "2024-06-17T04:07:13.000 UTC",
  "useCustomRequestBody": false
}

Updates a callout template. This operation supports updating the callout template for all event types.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

idstringRequiredformat: "uuid"

The ID of the callout template to be updated.

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Request

The request body to update a callout template.

Variant:

Callout - without authenticationobjectRequired

Common information for callout templates.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

activebooleanOptional

The status of the callout template.

calloutAuthobjectOptional

If requiredAuth is true, this object is required.

calloutBaseurlstringOptionalformat: "url">=10 characters

The callout URL.

calloutHeadersmap from strings to strings or nullOptional

Container for custom callout headers. Each custom callout header consists of a header name and a header value.

calloutParamsmap from strings to strings or nullOptional

Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value.

calloutRetrybooleanOptional

Indicates whether to retry the callout when the callout fails.

certificatestring or nullOptional

The SSL certificate for the domain of the callout receiver server specified in calloutBaseurl.

confirmSuccessFromResponseContentbooleanOptional

Indicates how Zuora determines whether callout notifications to your system succeed or fail:

If false, Zuora determines the result based solely on the HTTP response status code. This is the default value.
If true, and the HTTP response status code is 200, Zuora evaluates the callout response and considers the notification successful only if the Content-Type header is set to application/json, and the response body contains a success field set to true.

contentTypestringOptional

The callout body format.

createdBystringOptionalformat: "uuid"

The ID of the user who created the callout template.

createdOndatetimeOptional

The time when the callout template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00

customRequestBodystring or nullOptional

Customized request body.

descriptionstringOptional<=255 characters

Description for the callout template.

eventCategorydoubleOptional

The event category code for the standard event that the callout template relates to.

This field is available only if the related event of this callout template is a standard event.

For the list of supported standard event category codes, see Standard event category code for events and notifications.

eventTypeNamestringOptional>=1 character

The name of the custom event that the callout template relates to. This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event.

eventTypeNamespaceenumOptional

The namespace of the eventTypeName field. It indicates who created the event and which namespace the event is assigned to.

Supported values are as follows:

com.zuora.notification: events that are created by Zuora. This value applies to Zuora custom events.
user.notification: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value.

This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event.

Allowed values:

hmacAlgorithmenum or nullOptional

The hash function Zuora uses to generate the signed data for HMAC authentication.

hmacDatastring or nullOptional

The message to be authenticated for HMAC authentication.

hmacKeystring or nullOptional

The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the hmacValue field and typically contains the signed data.

hmacOutputFormatenum or nullOptional

The format of the signed data for HMAC authentication.

Allowed values:

hmacSecretstring or nullOptional

The shared secret key that Zuora uses to generate the signed data for HMAC authentication.

hmacValuestring or nullOptional

The header value for HMAC authentication. The header key is specified in the hmacKey field.

httpMethodenumOptional

The HTTP method of the callout.

Allowed values:

idstringOptionalformat: "uuid"

The ID of the callout template.

namestringOptional<=255 characters

The name of the callout template.

oauth2ProviderIdstring or nullOptional

The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout.

requiredAuthbooleanOptional

Indicates whether Basic authentication is enabled for the callout.

requiredOauth2booleanOptional

Indicates whether OAuth 2.0 authentication is enabled for the callout.

updatedBystringOptionalformat: "uuid"

The ID of the user who updated the callout template.

updatedOndatetimeOptional

The time when the callout template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00

useCustomRequestBodybooleanOptional

Indicates whether to enable the customized request body configured in the customRequestBody field.

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

415

Unsupported Media Type Error

500

Internal Server Error