Update a custom code block
/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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
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
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`.