PUT 3/surveys/{surveyId}/channels/targetedPanels/Urls/{urlId}

Definition

PUT - 3/surveys/{surveyId}/channels/targetedPanels/Urls/{urlId}

Updates channel URL for the targeted panel in a survey

Required roles: Survey (write)

Request information

Uri parameters

Name	Description	Type	Additional information
surveyId The id of the survey for which channel needs to be created. Type integer Additional info Required
surveyId	The id of the survey for which channel needs to be created.	integer	Required
urlId Channel Id of the channel which needs to be updated. Type integer Additional info Required
urlId	Channel Id of the channel which needs to be updated.	integer	Required

Request body fields

Channel details which needs to be updated.

Name	Description	Type	Additional information
Name Channel name of the panel Type string Additional info Required
Name	Channel name of the panel	string	Required
QueryName Query string parameter for panel Type string Additional info If null or empty will defaults to "pid"
QueryName	Query string parameter for panel	string	If null or empty will defaults to "pid"
OrderId Order Id of the channel Type string
OrderId	Order Id of the channel	string
CompleteUrl Complete URL for the panel Type string
CompleteUrl	Complete URL for the panel	string
TerminateUrl Terminate/disqualified URL for the panel Type string
TerminateUrl	Terminate/disqualified URL for the panel	string
OverQuotaUrl Over quota URL for the panel Type string
OverQuotaUrl	Over quota URL for the panel	string

Sample:

{
  "Name": "sample string 2",
  "QueryName": "sample string 3",
  "OrderId": "sample string 4",
  "CompleteUrl": "sample string 6",
  "TerminateUrl": "sample string 7",
  "OverQuotaUrl": "sample string 8"
}

Sample:

<UrlManagementChannel xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 2</Name>
  <QueryName>sample string 3</QueryName>
  <OrderId>sample string 4</OrderId>
  <CompleteUrl>sample string 6</CompleteUrl>
  <TerminateUrl>sample string 7</TerminateUrl>
  <OverQuotaUrl>sample string 8</OverQuotaUrl>
</UrlManagementChannel>

Response information

Response body fields

Returns channel Id of channel updated.

Name	Description	Type
Meta The metadata such as paging parameters, status code, timestamp,... which are related to this request. Type MetaData
Meta	The metadata such as paging parameters, status code, timestamp,... which are related to this request.	MetaData
Data The actual data returned by the request. Type UrlManagementChannelResult
Data	The actual data returned by the request.	UrlManagementChannelResult
Links HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. Type Hateoas
Links	HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.	Hateoas

Note about API metadata
The API uses the same metadata structure for all endpoints, but not every field applies to every endpoint. Fields such as paging details (for example Limit, Offset and TotalRowCount) and IsFiltered are only returned by endpoints that support them. Fields that do not apply are not included in the actual response.

JSON
XML

Sample:

{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2026-11-13T20:34:51.6730229Z",
    "IsFiltered": true
  },
  "Data": {
    "Succeeded": true,
    "FailureMessage": "sample string 2",
    "UrlId": 3
  }
}

Sample:

<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <FailureMessage>sample string 2</FailureMessage>
    <Succeeded>true</Succeeded>
    <UrlId>3</UrlId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2026-11-13T20:34:51.6730229+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>

Definition