Create quick link

POST

messaging

quicklinks

Create quick link

curl --request POST \
  --url https://api.polymorfa.com/messaging/quicklinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "methods": [],
  "businessName": "<string>",
  "callbackUrl": "<string>",
  "accent": "<string>",
  "prefillPhone": "<string>",
  "expiresInSeconds": 1950
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    methods: [],
    businessName: '<string>',
    callbackUrl: '<string>',
    accent: '<string>',
    prefillPhone: '<string>',
    expiresInSeconds: 1950
  })
};

fetch('https://api.polymorfa.com/messaging/quicklinks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/quicklinks"

payload = {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "methods": [],
    "businessName": "<string>",
    "callbackUrl": "<string>",
    "accent": "<string>",
    "prefillPhone": "<string>",
    "expiresInSeconds": 1950
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/quicklinks"

	payload := strings.NewReader("{\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"methods\": [],\n  \"businessName\": \"<string>\",\n  \"callbackUrl\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"prefillPhone\": \"<string>\",\n  \"expiresInSeconds\": 1950\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "id": "<string>",
    "url": "<string>",
    "session": "<string>",
    "expiresAt": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Body

application/json

projectId

string<uuid>

Project that receives the connected number. Required for organization keys with more than one project.

Value constraints

Constraint	Accepted input
Format	`uuid`

customerId

string<uuid>

Customer that owns the connected number when Customers is enabled for the project.

Value constraints

Constraint	Accepted input
Format	`uuid`

methods

enum<string>[]

Connection methods offered on the hosted page. Defaults to the saved settings, then to both.

Allowed item values

Item value	Meaning
`qr`	Qr.
`pairing`	Pairing.

Value constraints

Constraint	Accepted input
Array size	`1` through `2` items

Required array length: 1 - 2 elements

Available options:

qr,

pairing

businessName

string

Name shown to the recipient when no saved business name exists.

Value constraints

Constraint	Accepted input
String length	`1` through `120` characters

Required string length: 1 - 120

historySync

enum<string>

History synchronization behavior for newly connected sessions.

Allowed values

Value	Meaning
`ask`	Ask.
`force_on`	Force on.
`force_off`	Force off.

Available options:

ask,

force_on,

force_off

callbackUrl

string<uri>

Exact HTTPS URL without credentials. Must match a saved redirect URL.

Value constraints

Constraint	Accepted input
String length	At most `2048` characters
Format	`uri`
Pattern	`^[Hh][Tt][Tt][Pp][Ss]://`

Maximum string length: 2048

Pattern: ^[Hh][Tt][Tt][Pp][Ss]://

theme

enum<string>

Visual theme used by the widget.

Allowed values

Value	Meaning
`light`	Light.
`dark`	Dark.
`system`	System.

Available options:

light,

dark,

system

accent

string

Specifies accent for this native create quick link request.

Value constraints

Constraint	Accepted input
Pattern	`^#[0-9a-fA-F]{6}$`

Pattern: ^#[0-9a-fA-F]{6}$

prefillPhone

string

Pre-fills the phone number for the pairing-code method.

Value constraints

Constraint	Accepted input
Pattern	`^\+?\d{6,15}$`

Pattern: ^\+?\d{6,15}$

expiresInSeconds

integer

Link lifetime in seconds, 300–3600. Defaults to 900.

Value constraints

Constraint	Accepted input
Numeric value	`300` through `3600` (inclusive)

Required range: 300 <= x <= 3600

Response

QuickLink created

success

enum<boolean>

required

Whether the request succeeded.

Allowed values

Value	Meaning
`true`	True.

Available options:

true

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Create quick link

curl --request POST \
  --url https://api.polymorfa.com/messaging/quicklinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "methods": [],
  "businessName": "<string>",
  "callbackUrl": "<string>",
  "accent": "<string>",
  "prefillPhone": "<string>",
  "expiresInSeconds": 1950
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    methods: [],
    businessName: '<string>',
    callbackUrl: '<string>',
    accent: '<string>',
    prefillPhone: '<string>',
    expiresInSeconds: 1950
  })
};

fetch('https://api.polymorfa.com/messaging/quicklinks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/quicklinks"

payload = {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "methods": [],
    "businessName": "<string>",
    "callbackUrl": "<string>",
    "accent": "<string>",
    "prefillPhone": "<string>",
    "expiresInSeconds": 1950
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/quicklinks"

	payload := strings.NewReader("{\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"methods\": [],\n  \"businessName\": \"<string>\",\n  \"callbackUrl\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"prefillPhone\": \"<string>\",\n  \"expiresInSeconds\": 1950\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": {
    "id": "<string>",
    "url": "<string>",
    "session": "<string>",
    "expiresAt": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Authorizations

Body

Response