Create connect session | Channel3 Partner Program

Create a short-lived, single-use hosted connect session.

x-api-keystring

API Key authentication via header

customer_idstringRequired

This endpoint expects an object.

redirect_uristringRequired

Where the hosted flow redirects on completion. Must prefix-match a URI on your registered allowlist.

platformenum or nullOptional

Platform slug to deep-link to (validated against the connectable catalog). Omit to show the picker.

Successful Response

tokenstring

urlstring

expires_atstring

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

$	curl -X POST https://partners.trychannel3.com/v0/partner/merchants/customer_id/connections/sessions \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"redirect_uri": "https://merchant.example.com/connect/callback"
>	}'

1	{
2	"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ik1lcmNoYW50IENvbm5lY3Rpb24iLCJpYXQiOjE2ODU0MjQwMDB9.s5X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7X9vQ7",
3	"url": "https://connect.trychannel3.com/session/abc123def456",
4	"expires_at": "2024-07-01T15:00:00Z"
5	}