Create customer pairing link

POST

platform

customers

{customerId}

pairing-links

Create customer pairing link

curl --request POST \
  --url https://api.polymorfa.com/platform/customers/{customerId}/pairing-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expectedPhone": "<string>",
  "methods": [],
  "expiresInSeconds": 86400
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expectedPhone: '<string>',
    methods: [],
    expiresInSeconds: 86400
  })
};

fetch('https://api.polymorfa.com/platform/customers/{customerId}/pairing-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/customers/{customerId}/pairing-links"

payload = {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expectedPhone": "<string>",
    "methods": [],
    "expiresInSeconds": 86400
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "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/platform/customers/{customerId}/pairing-links"

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

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expectedPhoneMasked": "<string>",
    "methods": [
      "qr"
    ],
    "locale": "en",
    "theme": "light",
    "expiresAt": 123,
    "status": "active",
    "attemptCount": 1,
    "maxAttempts": 10,
    "pendingSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdBy": "<string>",
    "reservedAt": 123,
    "openedAt": 123,
    "connectingAt": 123,
    "connectedAt": 123,
    "failedAt": 123,
    "expiredAt": 123,
    "revokedAt": 123,
    "lastErrorCode": "<string>",
    "failedExchangeCount": 2,
    "phoneMismatchCount": 1,
    "createdAt": 123,
    "updatedAt": 123,
    "url": "<string>"
  }
}

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

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

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

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

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

Authorizations

Authorization

string

header

required

Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected.

Headers

Idempotency-Key

string

required

Specifies idempotency key for this header parameter.

Value constraints

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

Required string length: 1 - 255

Path Parameters

customerId

string<uuid>

required

Identifier for the customer.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

projectId

string<uuid>

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

expectedPhone

string | null

Optional expected phone, normalized to E.164.

Accepted alternatives

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

methods

enum<string>[]

Connection methods enabled for the widget.

Allowed item values

Item value	Meaning
`qr`	Qr.
`phone`	Phone.

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,

phone

expiresInSeconds

integer

default:86400

Specifies expires in seconds for this management create customer pairing link request.

Value constraints

Constraint	Accepted input
Numeric value	`900` through `604800` (inclusive)

Required range: 900 <= x <= 604800

locale

enum<string> | null

Specifies locale for this management create customer pairing link request.

Allowed values

Value	Meaning
`en`	En.
`pt-BR`	Pt br.
`null`	Null.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Value `en` or `pt-BR`
Alternative 2	`null`

Available options:

en,

pt-BR,

null

theme

enum<string> | null

Visual theme used by the widget.

Allowed values

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

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Value `light` or `dark` or `system`
Alternative 2	`null`

Available options:

light,

dark,

system,

null

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Create customer pairing link

curl --request POST \
  --url https://api.polymorfa.com/platform/customers/{customerId}/pairing-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expectedPhone": "<string>",
  "methods": [],
  "expiresInSeconds": 86400
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    expectedPhone: '<string>',
    methods: [],
    expiresInSeconds: 86400
  })
};

fetch('https://api.polymorfa.com/platform/customers/{customerId}/pairing-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/customers/{customerId}/pairing-links"

payload = {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expectedPhone": "<string>",
    "methods": [],
    "expiresInSeconds": 86400
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "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/platform/customers/{customerId}/pairing-links"

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

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

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	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",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expectedPhoneMasked": "<string>",
    "methods": [
      "qr"
    ],
    "locale": "en",
    "theme": "light",
    "expiresAt": 123,
    "status": "active",
    "attemptCount": 1,
    "maxAttempts": 10,
    "pendingSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdBy": "<string>",
    "reservedAt": 123,
    "openedAt": 123,
    "connectingAt": 123,
    "connectedAt": 123,
    "failedAt": 123,
    "expiredAt": 123,
    "revokedAt": 123,
    "lastErrorCode": "<string>",
    "failedExchangeCount": 2,
    "phoneMismatchCount": 1,
    "createdAt": 123,
    "updatedAt": 123,
    "url": "<string>"
  }
}

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

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

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

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

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

Overview

Messaging API

Platform API

Graph API

Webhook events

Create customer pairing link

Authorizations

Headers

Path Parameters

Body

Response