/v1/marketing-qr-codes (POST)

POST

/v1/marketing-qr-codes

curl --request POST \
  --url https://example.com/v1/marketing-qr-codes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "url": "example", "name": "example", "expires_at": "example", "expired_url": "example", "ios_url": "example", "android_url": "example", "notes": "example", "utm_source": "example", "utm_medium": "example", "utm_campaign": "example", "utm_term": "example", "utm_content": "example" }'

Create a marketing QR code in a workspace. The code is a draft until POST /{id}/publish assigns its short link. You only see workspaces you are a member of.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

workspace_id

required

string format: uuid

url

required

Destination URL the QR code redirects to

string

>= 1 characters <= 2000 characters

name

string

<= 2000 characters

expires_at

string

<= 2000 characters

expired_url

string

<= 2000 characters

ios_url

string

<= 2000 characters

android_url

string

<= 2000 characters

notes

string

<= 2000 characters

utm_source

string

<= 2000 characters

utm_medium

string

<= 2000 characters

utm_campaign

string

<= 2000 characters

utm_term

string

<= 2000 characters

utm_content

string

<= 2000 characters

Example^generated

{
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "url": "example",
  "name": "example",
  "expires_at": "example",
  "expired_url": "example",
  "ios_url": "example",
  "android_url": "example",
  "notes": "example",
  "utm_source": "example",
  "utm_medium": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_content": "example"
}

Responses

201

The created QR code

Media typeapplication/json

object

id

required

string format: uuid

workspace_id

required

string format: uuid

name

required

string | null

<= 2000 characters

url

required

string | null

<= 2000 characters

short_url

required

string | null

<= 2000 characters

is_published

required

boolean | null

published_at

required

string | null

<= 2000 characters

expires_at

required

string | null

<= 2000 characters

expired_url

required

string | null

<= 2000 characters

ios_url

required

string | null

<= 2000 characters

android_url

required

string | null

<= 2000 characters

notes

required

string | null

<= 2000 characters

utm_source

required

string | null

<= 2000 characters

utm_medium

required

string | null

<= 2000 characters

utm_campaign

required

string | null

<= 2000 characters

utm_term

required

string | null

<= 2000 characters

utm_content

required

string | null

<= 2000 characters

geo_count

required

integer | null

created_at

required

string | null

<= 2000 characters

updated_at

required

string | null

<= 2000 characters

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "url": "example",
  "short_url": "example",
  "is_published": true,
  "published_at": "example",
  "expires_at": "example",
  "expired_url": "example",
  "ios_url": "example",
  "android_url": "example",
  "notes": "example",
  "utm_source": "example",
  "utm_medium": "example",
  "utm_campaign": "example",
  "utm_term": "example",
  "utm_content": "example",
  "geo_count": 1,
  "created_at": "example",
  "updated_at": "example"
}

400

Invalid body

Media typeapplication/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

401

Missing or invalid bearer token

Media typeapplication/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

403

Not a member of the workspace

Media typeapplication/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}

502

Upstream error

Media typeapplication/problem+json

object

type

required

string

<= 2000 characters

title

required

string

<= 2000 characters

status

required

number

detail

string

<= 2000 characters

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example"
}