Create testing session

POST

platform

sessions

testing

curl --request POST \
  --url https://api.polymorfa.com/platform/sessions/testing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

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

import requests

url = "https://api.polymorfa.com/platform/sessions/testing"

payload = { "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
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/platform/sessions/testing"

	payload := strings.NewReader("{\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))

}

{
  "data": "<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.

Body

application/json

projectId

string<uuid>

required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

customerId

string<uuid>

Customer owner. Defaults to the protected Default customer when Customers is enabled.

Value constraints

Constraint	Accepted input
Format	`uuid`

name

string

Optional Console display name.

Value constraints

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

Required string length: 1 - 100

country

enum<string>

default:US

WhatsApp-supported ISO 3166-1 alpha-2 country used to generate a realistic E.164 identity.

Allowed values

Value	Meaning
`ES`	Es.
`DE`	De.
`MX`	Mx.
`GB`	Gb.
`SA`	Sa.
`IT`	It.
`AF`	Af.
`AX`	Ax.
`AL`	Al.
`DZ`	Dz.
`AS`	As.
`AD`	Ad.
`AO`	Ao.
`AI`	Ai.
`AG`	Ag.
`AR`	Ar.
`AM`	Am.
`AW`	Aw.
`AC`	Ac.
`AU`	Au.
`AT`	At.
`AZ`	Az.
`BS`	Bs.
`BH`	Bh.
`BD`	Bd.
`BB`	Bb.
`BY`	By.
`BE`	Be.
`BZ`	Bz.
`BJ`	Bj.
`BM`	Bm.
`BT`	Bt.
`BO`	Bo.
`BQ`	Bq.
`BA`	Ba.
`BW`	Bw.
`BR`	Br.
`IO`	Io.
`VG`	Vg.
`BN`	Bn.
`BG`	Bg.
`BF`	Bf.
`BI`	Bi.
`CI`	Ci.
`KH`	Kh.
`CM`	Cm.
`CA`	Ca.
`CV`	Cv.
`KY`	Ky.
`CF`	Cf.
`TD`	Td.
`CL`	Cl.
`CN`	Cn.
`CX`	Cx.
`CC`	Cc.
`CO`	Co.
`KM`	Km.
`CG`	Cg.
`CD`	Cd.
`CK`	Ck.
`CR`	Cr.
`HR`	Hr.
`CU`	Cu.
`CW`	Cw.
`CY`	Cy.
`CZ`	Cz.
`DK`	Dk.
`DJ`	Dj.
`DM`	Dm.
`DO`	Do.
`EC`	Ec.
`EG`	Eg.
`SV`	Sv.
`GQ`	Gq.
`ER`	Er.
`EE`	Ee.
`ET`	Et.
`FK`	Fk.
`FO`	Fo.
`FJ`	Fj.
`FI`	Fi.
`FR`	Fr.
`GF`	Gf.
`PF`	Pf.
`GA`	Ga.
`GM`	Gm.
`GE`	Ge.
`GH`	Gh.
`GI`	Gi.
`GR`	Gr.
`GL`	Gl.
`GD`	Gd.
`GP`	Gp.
`GU`	Gu.
`GT`	Gt.
`GG`	Gg.
`GN`	Gn.
`GW`	Gw.
`GY`	Gy.
`HT`	Ht.
`HN`	Hn.
`HK`	Hk.
`HU`	Hu.
`IS`	Is.
`IN`	In.
`ID`	Id.
`IR`	Ir.
`IQ`	Iq.
`IE`	Ie.
`IM`	Im.
`IL`	Il.
`JM`	Jm.
`JP`	Jp.
`JE`	Je.
`JO`	Jo.
`KZ`	Kz.
`KE`	Ke.
`KI`	Ki.
`KW`	Kw.
`KG`	Kg.
`LA`	La.
`LV`	Lv.
`LB`	Lb.
`LS`	Ls.
`LR`	Lr.
`LY`	Ly.
`LI`	Li.
`LT`	Lt.
`LU`	Lu.
`MO`	Mo.
`MK`	Mk.
`MG`	Mg.
`MW`	Mw.
`MY`	My.
`MV`	Mv.
`ML`	Ml.
`MT`	Mt.
`MH`	Mh.
`MQ`	Mq.
`MR`	Mr.
`MU`	Mu.
`YT`	Yt.
`FM`	Fm.
`MD`	Md.
`MC`	Mc.
`MN`	Mn.
`ME`	Me.
`MS`	Ms.
`MA`	Ma.
`MZ`	Mz.
`MM`	Mm.
`NA`	Na.
`NR`	Nr.
`NP`	Np.
`NL`	Nl.
`NC`	Nc.
`NZ`	Nz.
`NI`	Ni.
`NE`	Ne.
`NG`	Ng.
`NU`	Nu.
`NF`	Nf.
`KP`	Kp.
`MP`	Mp.
`NO`	No.
`OM`	Om.
`PK`	Pk.
`PW`	Pw.
`PS`	Ps.
`PA`	Pa.
`PG`	Pg.
`PY`	Py.
`PE`	Pe.
`PH`	Ph.
`PL`	Pl.
`PT`	Pt.
`PR`	Pr.
`QA`	Qa.
`RO`	Ro.
`RU`	Ru.
`RW`	Rw.
`RE`	Re.
`BL`	Bl.
`SH`	Sh.
`KN`	Kn.
`LC`	Lc.
`MF`	Mf.
`PM`	Pm.
`VC`	Vc.
`WS`	Ws.
`SM`	Sm.
`SN`	Sn.
`RS`	Rs.
`SC`	Sc.
`SL`	Sl.
`SG`	Sg.
`SX`	Sx.
`SK`	Sk.
`SI`	Si.
`SB`	Sb.
`SO`	So.
`ZA`	Za.
`KR`	Kr.
`SS`	Ss.
`LK`	Lk.
`SD`	Sd.
`SR`	Sr.
`SJ`	Sj.
`SZ`	Sz.
`SE`	Se.
`CH`	Ch.
`SY`	Sy.
`ST`	St.
`TW`	Tw.
`TJ`	Tj.
`TZ`	Tz.
`TH`	Th.
`TL`	Tl.
`TG`	Tg.
`TK`	Tk.
`TO`	To.
`TT`	Tt.
`TN`	Tn.
`TR`	Tr.
`TM`	Tm.
`TC`	Tc.
`TV`	Tv.
`VI`	Vi.
`UG`	Ug.
`UA`	Ua.
`AE`	Ae.
`US`	Us.
`UY`	Uy.
`UZ`	Uz.
`VU`	Vu.
`VA`	Va.
`VE`	Ve.
`VN`	Vn.
`WF`	Wf.
`YE`	Ye.
`ZM`	Zm.
`ZW`	Zw.
`XK`	Xk.

Available options:

ES,

DE,

MX,

GB,

SA,

IT,

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AG,

AR,

AM,

AW,

AC,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BR,

IO,

VG,

BN,

BG,

BF,

BI,

CI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

GA,

GM,

GE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

KP,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

KR,

SS,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

ST,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

VI,

UG,

UA,

AE,

US,

UY,

UZ,

VU,

VA,

VE,

VN,

WF,

YE,

ZM,

ZW,

XK

Response

Success

data

string

required

Structured data carried by this object.

Value constraints

Constraint	Accepted input
Pattern	`^test_[A-Za-z0-9_-]{16}$`

Pattern: ^test_[A-Za-z0-9_-]{16}$

⌘I

Create testing session

curl --request POST \
  --url https://api.polymorfa.com/platform/sessions/testing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({projectId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

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

import requests

url = "https://api.polymorfa.com/platform/sessions/testing"

payload = { "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
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/platform/sessions/testing"

	payload := strings.NewReader("{\n  \"projectId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))

}

{
  "data": "<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 testing session

Authorizations

Body

Response