Update Content Block

POST https://{{instance_url}}/content_blocks/update

Request Parameters

ParameterRequiredData TypeDescription
content_block_idYesStringYour Content Block's API Identifier.
nameYesStringCan only be provided when the content block is in a draft state. Must be less than 100 characters.
descriptionNoStringThe description of the content block. Must be less than 250 characters.
contentYesStringHTML or text content within Content Block.
stateOptionalactive or draftChoose active or draft. Defaults to active if not specified. Can not set an active content block to draft.
tagsNoArray of Strings.Tags must already exist.

Successful Response Properties

{
  "content_block_id": "newly-generated-block-id",
  "liquid_tag": "generated-block-tag-from-content_block_name",
  "created_at": "time-created-in-iso",
  "message": "success"
}

Possible Errors

  • Content cannot be blank.

  • Content must be a string.

  • Content must be smaller than 50kb. The content in your content block must be less than 50kb total.

  • Content contains malformed liquid. The liquid provided is not valid or parsable. Please try again or reach out to support.

  • Content Block cannot be referenced within itself.

  • Content Block description cannot be blank.

  • Content Block description must be a string.

  • Content block description must be shorter than 250 characters. Your content block description must be less than 250 characters.

  • Content Block name cannot be blank.

  • Content Block name must be a shorter than 100 characters.

  • Content Block name can only contain alphanumeric characters. Content Block names can include any of the following characters: the letters (capitalized or lowercase) A through Z, the numbers 0 through 9, dashes -, and underscores _. It cannot contain non-alphanumeric characters like emojis, !, @, ~, &, and other special characters.

  • Content Block with this name already exists.

  • Content Block name cannot be updated for active Content Blocks.

  • Content Block state must be either Active or Draft.

  • Active Content Block can not be updated to Draft. Please create a new Content Block.

  • Tags must be an array.

  • All Tags must be Strings.

  • Some Tags could not be found.

Request Body

{"content_block_id"=>"content_block_id", "name"=>"content_block", "description"=>"This is my content block", "content"=>"HTML or text content within block", "state"=>"draft", "tags"=>["marketing"]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Authorizationstring