Bind Custom Field to Asset

Last modified: July 08, 2021

To bind a custom field to an asset, use the /rest/1/bind-custom-field endpoint.

Curl Request 

curl -X POST "http://localhost:8080/rest/1/bind-custom-field" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"customFields\": [ \"t1219328148\" ], \"xid\": \"term\"}"

Request Parameters

req: (Required) To bind a custom field to an asset, specify the custom field ID and the asset type. 

Example Value


  "customFields": [



  "xid": "term"


Server Response Example

Response Body

  "data": "Binding successful",
  "isSuccess": true

Response Headers

 cache-control: no-cache, no-store, max-age=0, must-revalidate 
 connection: Keep-Alive 
 content-length: 46 
 content-type: application/json;charset=ISO-8859-1 
 date: Tue, 01 Sep 2020 10:07:49 GMT 
 expires: 0 
 keep-alive: timeout=5, max=99 
 pragma: no-cache 
 server: Apache/2.4.10 (Debian) 
 x-content-type-options: nosniff 
 x-frame-options: DENY 
 x-xss-protection: 1; mode=block 
Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.