POST

Create link map

https://linkshift.app/api/v1/link-maps

Creates a link map that can be referenced by redirect rules for key-based resolution.

Operation ID:createLinkMapTags: Link Maps

Back to API reference

Security

ApiKeyAuth: apiKey | header:X-API-Key | API key generated in LinkShift dashboard (`Organization -> Manage API keys`).

Parameters

This endpoint has no parameters.

Request body schema

requestBodyobjectrequired

Payload for creating a link map.

caseSensitiveboolean

Whether key matching is case sensitive.

default: false

domainGroupIdstringrequired

Parent domain-group ID.

fallbackDestinationstring

Fallback destination URL used when key lookup misses.

namestringrequired

Link-map display name.

minLength: 1maxLength: 120

queryMatchstring

Query matching strategy for key resolution requests.

default: ignoreenum: exact, ignore, subset

Response schema

Created link map

Content type: application/json

response 200objectrequired

Link map used to resolve short keys to destinations.

caseSensitivebooleanrequired

Controls key matching case sensitivity.

createdAtstringrequired

Creation timestamp (UTC).

format: date-time

deletedAtstring | nullnullable

Soft-delete timestamp in UTC when deleted.

format: date-time

domainGroupIdstringrequired

Parent domain-group ID.

fallbackDestinationstring | nullnullable

Optional destination used when no key matches.

idstringrequired

Link-map ID.

namestringrequired

Human-readable link-map name.

queryMatchstringrequired

Query-string matching strategy for key resolution requests.

enum: exact, ignore, subset

updatedAtstringrequired

Last update timestamp (UTC).

format: date-time