POST /qr-codes/static

Generate a static QR code image without creating or saving a QR code resource. SVG and PNG output are supported via the Accept header Contact your Account Manager to discuss enabling this feature for your account.

The render_customizations field supports basic appearance options. Customizations that require the rasterize API are not supported: gradient, background_gradient, frame, text, and logo.

The Accept header controls the response format:

application/json (default): Returns a JSON object with the image as a base64-encoded byte string.
image/svg+xml: Returns the raw SVG image.
image/png: Returns the raw PNG image.

Servers

https://api-ssl.bitly.com/v4

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	No	Controls the response format. Use `application/json` (default) to receive a JSON-wrapped base64 image, `image/svg+xml` to receive the raw SVG, or `image/png` to receive the raw PNG. Valid values: `"image/png"` `"application/json"` `"image/svg+xml"`
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Accept

String

Controls the response format. Use application/json (default) to receive a JSON-wrapped base64 image, image/svg+xml to receive the raw SVG, or image/png to receive the raw PNG.

Valid values:

"image/png"
"application/json"
"image/svg+xml"

Content-Type

String

Yes

The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description

Name	Type	Required	Description
`format`	String	No	The image format. Supports `svg` and `png`. Ignored if the Accept header specifies an image type. Valid values: `"svg"` `"png"` Default value: "svg"

format

String

The image format. Supports svg and png. Ignored if the Accept header specifies an image type.

Valid values:

"svg"
"png"

Default value: "svg"

Request body fields

Name	Type	Required	Description
`render_customizations`	Object	No	Appearance options for a static QR code. gradient, background_gradient, frame, text, and logo are not supported.
`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.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
`group_guid`	String	Yes	The group (brand) GUID used for access control and analytics.
`content`	String	Yes	The raw content to encode in the QR code (e.g. a URL).

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.