Make a short link

POST

/api/v1/ads/short-links

curl --request POST \
  --url https://digize.com/api/v1/ads/short-links \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "destination": "https://example.com", "slug": "example", "utm": null }'

• Digize

Makes a short link on the workspace’s short link domain that counts each click before going on to the destination with its UTM tags.

Needs the ads:write permission.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

destination

required

string format: uri

<= 2000 characters

slug

Any of:

string

string

<= 64 characters

null

null

utm

Any of:

object

object

source

required

string

<= 100 characters

medium

required

string

<= 100 characters

campaign

required

string

<= 100 characters

null

null

Responses

201

Done

Media typeapplication/json

object

id

required

string

domain

required

string

slug

required

string

destination

required

string

utm

required

Any of:

object

object

source

required

string

<= 100 characters

medium

required

string

<= 100 characters

campaign

required

string

<= 100 characters

null

null

orders

required

number

revenue

required

number

createdAt

required

string format: date-time

Example ^generated

{
  "id": "example",
  "domain": "example",
  "slug": "example",
  "destination": "example",
  "utm": {
    "source": "example",
    "medium": "example",
    "campaign": "example"
  },
  "orders": 1,
  "revenue": 1,
  "createdAt": "2026-04-15T12:00:00Z"
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}