Update quick link settings

PUT

platform

quicklink

curl --request PUT \
  --url https://api.polymorfa.com/platform/quicklink \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "successCallbackUrl": "<string>",
  "failureCallbackUrl": "<string>",
  "businessName": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "successMessage": "<string>",
  "supportUrl": "<string>",
  "privacyUrl": "<string>",
  "termsUrl": "<string>",
  "accent": "<string>",
  "hideWatermark": true,
  "allowPhoneChange": true,
  "radiusPx": 499.5,
  "logoStorageId": "<string>",
  "logoSourceStorageId": "<string>",
  "methods": []
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enabled: true,
    successCallbackUrl: '<string>',
    failureCallbackUrl: '<string>',
    businessName: '<string>',
    headline: '<string>',
    description: '<string>',
    successMessage: '<string>',
    supportUrl: '<string>',
    privacyUrl: '<string>',
    termsUrl: '<string>',
    accent: '<string>',
    hideWatermark: true,
    allowPhoneChange: true,
    radiusPx: 499.5,
    logoStorageId: '<string>',
    logoSourceStorageId: '<string>',
    methods: []
  })
};

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

import requests

url = "https://api.polymorfa.com/platform/quicklink"

payload = {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": True,
    "successCallbackUrl": "<string>",
    "failureCallbackUrl": "<string>",
    "businessName": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "successMessage": "<string>",
    "supportUrl": "<string>",
    "privacyUrl": "<string>",
    "termsUrl": "<string>",
    "accent": "<string>",
    "hideWatermark": True,
    "allowPhoneChange": True,
    "radiusPx": 499.5,
    "logoStorageId": "<string>",
    "logoSourceStorageId": "<string>",
    "methods": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/quicklink"

	payload := strings.NewReader("{\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\n  \"successCallbackUrl\": \"<string>\",\n  \"failureCallbackUrl\": \"<string>\",\n  \"businessName\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"supportUrl\": \"<string>\",\n  \"privacyUrl\": \"<string>\",\n  \"termsUrl\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"hideWatermark\": true,\n  \"allowPhoneChange\": true,\n  \"radiusPx\": 499.5,\n  \"logoStorageId\": \"<string>\",\n  \"logoSourceStorageId\": \"<string>\",\n  \"methods\": []\n}")

	req, _ := http.NewRequest("PUT", 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))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "successCallbackUrl": "<string>",
    "failureCallbackUrl": "<string>",
    "businessName": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "successMessage": "<string>",
    "supportUrl": "<string>",
    "privacyUrl": "<string>",
    "termsUrl": "<string>",
    "accent": "<string>",
    "theme": "light",
    "hideWatermark": true,
    "allowPhoneChange": true,
    "shape": "square",
    "radiusPx": 123,
    "logoMode": "none",
    "logoStorageId": "<string>",
    "logoSourceStorageId": "<string>",
    "logoUrl": "<string>",
    "historySync": "ask",
    "methods": [
      "qr"
    ],
    "defaultMethod": "qr",
    "createdAt": 123,
    "updatedAt": 123
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json

QuickLink settings for the team or one project. Omitted fields keep their saved value; null clears an optional field.

projectId

string<uuid>

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

enabled

boolean

Allows QuickLinks to be created for the scope.

successCallbackUrl

string<uri> | null

Project-only destination after connection confirmation. Snapshotted when issuing a link.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `2048` characters; Format: `uri`; Pattern: `^[Hh][Tt][Tt][Pp][Ss]://`
Alternative 2	`null`

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]://

failureCallbackUrl

string<uri> | null

Project-only destination after cancellation. Snapshotted when issuing a link.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `2048` characters; Format: `uri`; Pattern: `^[Hh][Tt][Tt][Pp][Ss]://`
Alternative 2	`null`

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]://

businessName

string | null

Business name shown to the customer.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `120` characters
Alternative 2	`null`

Value constraints

Constraint	Accepted input
String length	At most `120` characters

Maximum string length: 120

headline

string | null

Page title shown above the pairing flow. Defaults to “Connect WhatsApp”.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `80` characters
Alternative 2	`null`

Value constraints

Constraint	Accepted input
String length	At most `80` characters

Maximum string length: 80

description

string | null

Intro sentence shown under the headline.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `280` characters
Alternative 2	`null`

Value constraints

Constraint	Accepted input
String length	At most `280` characters

Maximum string length: 280

successMessage

string | null

Message shown after the number connects.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `280` characters
Alternative 2	`null`

Value constraints

Constraint	Accepted input
String length	At most `280` characters

Maximum string length: 280

supportUrl

string<uri> | null

Help link shown on the page.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `2048` characters; Format: `uri`; Pattern: `^[Hh][Tt][Tt][Pp][Ss]://`
Alternative 2	`null`

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]://

privacyUrl

string<uri> | null

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `2048` characters; Format: `uri`; Pattern: `^[Hh][Tt][Tt][Pp][Ss]://`
Alternative 2	`null`

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]://

termsUrl

string<uri> | null

Terms link shown on the consent step.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; String length: At most `2048` characters; Format: `uri`; Pattern: `^[Hh][Tt][Tt][Pp][Ss]://`
Alternative 2	`null`

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]://

accent

string | null

Specifies accent for this management update quick link settings request.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Pattern: `^#[0-9A-Fa-f]{6}$`
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Pattern	`^#[0-9A-Fa-f]{6}$`

Pattern: ^#[0-9A-Fa-f]{6}$

theme

enum<string>

Visual theme used by the widget.

Allowed values

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

Available options:

light,

dark,

system

hideWatermark

boolean

Hide Powered by Polymorfa. Setting true requires an active team with a Branded QuickLink add-on; otherwise the request returns 402 with code addon_required.

allowPhoneChange

boolean

Allow recipients to change a prefilled phone number. Defaults to false.

shape

enum<string> | null

Specifies shape for this management update quick link settings request.

Allowed values

Value	Meaning
`square`	Square.
`rounded`	Rounded.
`pill`	Pill.
`null`	Null.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Value `square` or `rounded` or `pill`
Alternative 2	`null`

Available options:

square,

rounded,

pill,

null

radiusPx

number | null

Specifies radius px for this management update quick link settings request.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `number`; Numeric value: `0` through `999` (inclusive)
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Numeric value	`0` through `999` (inclusive)

Required range: 0 <= x <= 999

logoMode

enum<string>

Behavior selected for logo.

Allowed values

Value	Meaning
`none`	None.
`custom`	Custom.
`organization`	Organization.
`project`	Project.

Available options:

none,

custom,

organization,

project

logoStorageId

string | null

Identifier for the logo storage.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`
Alternative 2	`null`

logoSourceStorageId

string | null

Identifier for the logo source storage.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`
Alternative 2	`null`

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

methods

enum<string>[] | null

Connection methods offered on hosted QuickLink pages.

Allowed item values

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

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `array`; Array size: `1` through `2` items; Duplicates: Not accepted; every array item must be unique
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Array size	`1` through `2` items
Duplicates	Not accepted; every array item must be unique

Required array length: 1 - 2 elements

Available options:

qr,

pairing

defaultMethod

enum<string> | null

Method the page opens first. Unset lets the page choose by device.

Allowed values

Value	Meaning
`qr`	Qr.
`pairing`	Pairing.
`null`	Null.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Value `qr` or `pairing`
Alternative 2	`null`

Available options:

qr,

pairing,

null

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Update quick link settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/quicklink \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "successCallbackUrl": "<string>",
  "failureCallbackUrl": "<string>",
  "businessName": "<string>",
  "headline": "<string>",
  "description": "<string>",
  "successMessage": "<string>",
  "supportUrl": "<string>",
  "privacyUrl": "<string>",
  "termsUrl": "<string>",
  "accent": "<string>",
  "hideWatermark": true,
  "allowPhoneChange": true,
  "radiusPx": 499.5,
  "logoStorageId": "<string>",
  "logoSourceStorageId": "<string>",
  "methods": []
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enabled: true,
    successCallbackUrl: '<string>',
    failureCallbackUrl: '<string>',
    businessName: '<string>',
    headline: '<string>',
    description: '<string>',
    successMessage: '<string>',
    supportUrl: '<string>',
    privacyUrl: '<string>',
    termsUrl: '<string>',
    accent: '<string>',
    hideWatermark: true,
    allowPhoneChange: true,
    radiusPx: 499.5,
    logoStorageId: '<string>',
    logoSourceStorageId: '<string>',
    methods: []
  })
};

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

import requests

url = "https://api.polymorfa.com/platform/quicklink"

payload = {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": True,
    "successCallbackUrl": "<string>",
    "failureCallbackUrl": "<string>",
    "businessName": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "successMessage": "<string>",
    "supportUrl": "<string>",
    "privacyUrl": "<string>",
    "termsUrl": "<string>",
    "accent": "<string>",
    "hideWatermark": True,
    "allowPhoneChange": True,
    "radiusPx": 499.5,
    "logoStorageId": "<string>",
    "logoSourceStorageId": "<string>",
    "methods": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/quicklink"

	payload := strings.NewReader("{\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\n  \"successCallbackUrl\": \"<string>\",\n  \"failureCallbackUrl\": \"<string>\",\n  \"businessName\": \"<string>\",\n  \"headline\": \"<string>\",\n  \"description\": \"<string>\",\n  \"successMessage\": \"<string>\",\n  \"supportUrl\": \"<string>\",\n  \"privacyUrl\": \"<string>\",\n  \"termsUrl\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"hideWatermark\": true,\n  \"allowPhoneChange\": true,\n  \"radiusPx\": 499.5,\n  \"logoStorageId\": \"<string>\",\n  \"logoSourceStorageId\": \"<string>\",\n  \"methods\": []\n}")

	req, _ := http.NewRequest("PUT", 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))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": true,
    "successCallbackUrl": "<string>",
    "failureCallbackUrl": "<string>",
    "businessName": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "successMessage": "<string>",
    "supportUrl": "<string>",
    "privacyUrl": "<string>",
    "termsUrl": "<string>",
    "accent": "<string>",
    "theme": "light",
    "hideWatermark": true,
    "allowPhoneChange": true,
    "shape": "square",
    "radiusPx": 123,
    "logoMode": "none",
    "logoStorageId": "<string>",
    "logoSourceStorageId": "<string>",
    "logoUrl": "<string>",
    "historySync": "ask",
    "methods": [
      "qr"
    ],
    "defaultMethod": "qr",
    "createdAt": 123,
    "updatedAt": 123
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Update quick link settings

Authorizations

Body

Response