Generate a personalized Link Sharing URL

Generate a customer-specific survey link that can be delivered by a third-party system.

POST /external/v1/link_sharings/{link_channel_id}/generate_link

Authentication

Authentication Method API token via Authorization header

Request

Path Parameters

Parameter	Type	Required	Description	Example
`link_channel_id`	string	Yes	Link channel ID.	`<link_channel_id>`

Headers

Header	Required	Description	Example
`Accept`	No	Expected response format.	`application/json`
`Content-Type`	Yes	Request content type.	`application/json`
`Authorization`	Yes	Pisano API token.	`<API token>`

Request Body

{

"customer": {
"email": "",
"external_id": ""
},
"built_in_responses": {
"Segment": "",
"Location": "",
"TransactionDate": ""
},
"options": {
"shorten_url": true
}
}

Request Body Fields

Field	Type	Required	Description	Example
`customer`	object	Yes	Customer-specific fields. The object is required; sub-values can be empty.	`{}`
`customer.email`	string	No	Customer email address.	`<email>`
`customer.phone_number`	string	No	Customer phone number.	`<phone_number>`
`customer.name`	string	No	Customer name.	`<name>`
`customer.external_id`	string	No	Customer/external identifier.	`<external_id>`
`built_in_responses`	object	No	Feedback-related values embedded in the survey URL.	`{}`
`options`	object	No	Link generation options.	`{}`
`options.shorten_url`	boolean	No	When true, returns a shortened link.	`true`

Request Example

cURL

cURL Request Example

curl --location 'https://<pisanoURL>/external/v1/link_sharings/<link_channel_id>/generate_link' --header 'Accept: application/json' --header 'Authorization: <API token>' --header 'Content-Type: application/json' --data '{"customer":{"email":"<email>","external_id":"<external_id>"},"built_in_responses":{},"options":{"shorten_url":true}}'

Responses

200 OK (Successful)

Response Schema

Schema

└── link string

Response Fields

Field	Type	Required	Description	Example
`link`	string		Generated survey link.	`https://psn.vc/<short-code>`

Response Example

JSON Response Example

{

"link": "https://-pisanourl- /web_feedback?..."
}

Error Responses

400 Bad request

Bad request

Error Code: 13000
Error Message: An error occurred

401 Unauthorized

Unauthorized

Error Code: 13001
Error Message: Wrong authentication token

404 Not found

Not found

Error Code: 13002
Error Message: Requested resource not found

Additional Information

Rate Limits

20 requests in 8 seconds. On-premise throttle limits can be increased or removed and can be configured by IP.

Usage Limitations

For personalized links, Pisano documents one request per customer. A Link Channel must already exist and have a flow assigned.

Pisano External API - Link Sharing - Generate a Personalized Link Sharing URL