Developers
Custom code5

Create a custom code block

POST/settings/custom-code

Creates a custom code block that is injected into the platform pages.

Creating a block with type set to pushalertco also requires the custom_code.manage_pwa permission.

Code content is stored exactly as submitted and is not sanitized.

Authorization

AuthorizationBearer <token>

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

In: header

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._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. Repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

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

curl -X POST "https://example.com/settings/custom-code" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "position": "head",    "type": "string"  }'
{  "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"  }}

List custom code blocks GET

Returns the metadata of the account's custom code blocks, using cursor-based pagination. By default, only blocks that are not in the trash are returned. Set `deleted=true` to list only blocks in the trash. The `content` object is never included in this collection. To read a block's code, use the retrieve operation with the `custom_code.read_content` permission.

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.