Developers
Custom code5

Update a custom code block

PATCH/settings/custom-code/{custom_code_id}

Updates an existing custom code block. Only the fields present in the request are changed.

Changing status also requires the custom_code.activate permission. Changing the name or content of a pushalertco block also requires the custom_code.manage_pwa permission.

Send deleted: false to restore a block from the trash.

Send the ETag returned by the retrieve operation in the If-Match header to avoid overwriting changes made since the block was retrieved.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

custom_code_id*string

Public ID of the custom code, prefixed with cc_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

If-Match?string

Expected revision of the resource, in the same format as the ETag header (W/"<type>:<id>:<revision>"). If the resource has changed since that revision, the request fails with 412 and the revision_mismatch error code. * matches the current revision. Any other value fails with 400 and the if_match_invalid error code. When omitted, the update is applied to the current revision.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/settings/custom-code/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "content": {      "body": "string",      "header": "string",      "manifest_json": "string",      "sw_js": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "id": "string",    "name": "string",    "object": "custom_code",    "position": "head",    "revision": "string",    "status": "active",    "type": "active-campaign",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve a custom code block GET

Retrieves a custom code block by its public ID, including blocks in the trash. The block metadata is always returned. The `content` object (`header`, `body`, `sw_js`, and `manifest_json`) is included only when the credentials also have the `custom_code.read_content` permission, because code content often contains third-party tokens. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the block to avoid overwriting a newer version.

Delete a custom code block DELETE

Moves the custom code block to the trash instead of permanently deleting it. A block in the trash can be restored with the update operation by sending `deleted: false`.