Pricing Templates
Log in Sign up
Integrations / Bitly / ...

PATCH /qr-codes/{qrcode_id}

Updates the QR code with a matching id and returns it.

Servers

Path parameters

Name Type Required Description
qrcode_id String Yes

The QR code ID

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
render_customizations Object No

Options for customizing a QR Code's appearance
render_customizations.background_gradient Object No
render_customizations.background_gradient.angle Number No

The angle by which the gradient will be rotated. Only applies to linear gradients.
render_customizations.background_gradient.exclude_corners Boolean No

Ignore gradient mask on corners
render_customizations.background_gradient.colors[] Array No

The list of hex colors and their offsets to be used in the gradient.
render_customizations.background_gradient.colors[].color String No

A color in hexadecimal format to be used in one of the gradient's elements
render_customizations.background_gradient.colors[].offset Integer No

A number between 0-100 denoting the offset of the gradient color, interpreted as a percentage

Default value: 0
render_customizations.background_gradient.style String No

The style of the gradient. Can be either linear or radial.

Valid values:

  • "radial"
  • "linear"
  • "no_gradient"

Default value: "no_gradient"
render_customizations.frame Object No
render_customizations.frame.id String Yes

Valid values:

  • "text_top_and_bottom"
  • "text_bottom"
  • "url"
  • "tooltip_bottom"
  • "text_top"
  • "instagram"
  • "text_bottom_in_frame"
  • "script"
  • "none"
  • "arrow"
  • "border_only"

Default value: "none"
render_customizations.frame.text Object No

The text to be inserted into the QR code's frame
render_customizations.frame.text.primary Object No

An object describing text with color
render_customizations.frame.text.primary.content String Yes

The text to be used
render_customizations.frame.text.primary.color String No

The color of the text in hex code format

Default value: "#ffffff"
render_customizations.frame.text.secondary Object No

An object describing text with color
render_customizations.frame.text.secondary.content String Yes

The text to be used
render_customizations.frame.text.secondary.color String No

The color of the text in hex code format

Default value: "#ffffff"
render_customizations.frame.colors Object No

An object of named colors denoting which color should go to which area of the frame
render_customizations.frame.colors.primary String No

The primary color of the frame in hex code format
render_customizations.frame.colors.background String No

The background color of the frame in hex code format
render_customizations.frame.colors.secondary String No

The secondary color of the frame in hex code format
render_customizations.background_color String No

The QR code's background color in hex code format with values for alpha channel
render_customizations.spec_settings Object No

The QR code's editable spec settings, which for now is just the error correction
render_customizations.spec_settings.error_correction Integer No

The amount of error correction that the QR code was generated with
render_customizations.gradient Object No
render_customizations.gradient.angle Number No

The angle by which the gradient will be rotated. Only applies to linear gradients.
render_customizations.gradient.exclude_corners Boolean No

Ignore gradient mask on corners
render_customizations.gradient.colors[] Array No

The list of hex colors and their offsets to be used in the gradient.
render_customizations.gradient.colors[].color String No

A color in hexadecimal format to be used in one of the gradient's elements
render_customizations.gradient.colors[].offset Integer No

A number between 0-100 denoting the offset of the gradient color, interpreted as a percentage

Default value: 0
render_customizations.gradient.style String No

The style of the gradient. Can be either linear or radial.

Valid values:

  • "radial"
  • "linear"
  • "no_gradient"

Default value: "no_gradient"
render_customizations.logo Object No
render_customizations.logo.image_guid String No

A GUID for an image uploaded to Bitly
render_customizations.text Object No

Contains the center, top, and bottom text to be used in the QR code
render_customizations.text.center Object No

An object describing text with color
render_customizations.text.center.content String Yes

The text to be used
render_customizations.text.center.color String No

The color of the text in hex code format

Default value: "#ffffff"
render_customizations.text.top Object No

An object describing text with color
render_customizations.text.top.content String Yes

The text to be used
render_customizations.text.top.color String No

The color of the text in hex code format

Default value: "#ffffff"
render_customizations.text.bottom Object No

An object describing text with color
render_customizations.text.bottom.content String Yes

The text to be used
render_customizations.text.bottom.color String No

The color of the text in hex code format

Default value: "#ffffff"
render_customizations.dot_pattern_color String No

The QR code's dot pattern color in hex code format
render_customizations.branding Object No
render_customizations.branding.bitly_brand Boolean No

A boolean that determines if the QR code should have the bitly brand in its bottom right corner
render_customizations.dot_pattern_type String No

Valid values:

  • "star"
  • "circle"
  • "block"
  • "rounded"
  • "standard"
  • "triangle"
  • "diamond"
  • "heart"
  • "vertical"
  • "blob"
  • "horizontal"

Default value: "standard"
render_customizations.corners Object No

An object representing all three corners of the QR code. The corners corresponding to each property are: corner_1 = top left, corner_2 = top right, and corner_3 = bottom right
render_customizations.corners.corner_3 Object No

Represents one corner, both inner and outer, of a QR code, with color and shape values
render_customizations.corners.corner_3.shape String No

The shape one of the QR code's corners should take

Valid values:

  • "slightly_round"
  • "concave"
  • "rounded"
  • "standard"
  • "leaf"
  • "leaf_outer"
  • "target"
  • "extra_round"
  • "leaf_inner"

Default value: "standard"
render_customizations.corners.corner_3.outer_color String No

The outer color of a corner of the QR code in hex code format
render_customizations.corners.corner_3.inner_color String No

The inner color of a corner of the QR code in hex code format
render_customizations.corners.corner_1 Object No

Represents one corner, both inner and outer, of a QR code, with color and shape values
render_customizations.corners.corner_1.shape String No

The shape one of the QR code's corners should take

Valid values:

  • "slightly_round"
  • "concave"
  • "rounded"
  • "standard"
  • "leaf"
  • "leaf_outer"
  • "target"
  • "extra_round"
  • "leaf_inner"

Default value: "standard"
render_customizations.corners.corner_1.outer_color String No

The outer color of a corner of the QR code in hex code format
render_customizations.corners.corner_1.inner_color String No

The inner color of a corner of the QR code in hex code format
render_customizations.corners.corner_2 Object No

Represents one corner, both inner and outer, of a QR code, with color and shape values
render_customizations.corners.corner_2.shape String No

The shape one of the QR code's corners should take

Valid values:

  • "slightly_round"
  • "concave"
  • "rounded"
  • "standard"
  • "leaf"
  • "leaf_outer"
  • "target"
  • "extra_round"
  • "leaf_inner"

Default value: "standard"
render_customizations.corners.corner_2.outer_color String No

The outer color of a corner of the QR code in hex code format
render_customizations.corners.corner_2.inner_color String No

The inner color of a corner of the QR code in hex code format
archived Boolean No

A boolean representing if the QR code has been archived
expiration_at String No

Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year.
tags[] Array No

A list of tags to add to the QR code
title String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2026 SimWorkflow
Terms of Service Privacy Policy