mulaichatDocs
GuidesDeveloperAPI ReferenceChangelog
Links
POST
/v1/links

Paid plans (403 plan_feature_unavailable), up to 3 links on Starter, 5 on Basic, 10 on Pro and 25 on Agency (422 link_limit_reached). alias is Pro and Agency only (403 alias_requires_pro) and unique in any letter case (409 alias_taken). Refused with 422 destination_not_allowed (details.reason says which check): links to other shorteners, mulaichat.com itself or private networks, online gambling, domains on the Komdigi block list, and destinations Google Web Risk suspects of phishing or malware. The same checks run on a new destination and every day on active links, which are blocked when one fails.

Requires the write scope.

Authorization

bearer
headerAuthorizationBearer <token>

An API key (tb_live_...) from the dashboard, or an OAuth access token.

Header Parameters

Idempotency-Key?string

1-128 characters of [A-Za-z0-9_-]. The same key gives back the same link (200) instead of a new one.

mulaichat-workspace?string

Limits an owner key to one profile (id or external_id). Unknown: 404 profile_not_found.

Request Body

application/json
  1. body
url*string
Formaturi
Lengthlength <= 2048
title?string
Lengthlength <= 120
alias?string
Match^[A-Za-z0-9_-]{3,50}$

Response Body

The link made earlier with this Idempotency-Key.

application/json
  1. response
id*string
Formatuuid
profile_id*string
Formatuuid
code*string

The part after mulaichat.com/: 6 random characters, or the alias (Pro and Agency).

short_url*string

The link to share, e.g. https://mulaichat.com/aB3x9K.

url*string

Where the link leads; can be changed.

title*string|null
status*string

blocked: by Mulaichat for breaking the rules.

Value in"active""disabled""blocked"
clicks*integer

Once per visitor per link per hour; bots left out.

unique_visitors*integer

Each day's distinct visitors, added up.

bot_visits*integer

Link previews and crawlers, not counted as clicks.

last_clicked_at*|null
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X POST 'https://api.mulaichat.com/v1/links' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com"}'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "profile_id": "bfcb6779-b1f9-41fc-92d7-88f8bc1d12e8",  "code": "string",  "short_url": "string",  "url": "string",  "title": "string",  "status": "active",  "clicks": 0,  "unique_visitors": 0,  "bot_visits": 0,  "last_clicked_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

On this page