PUT /fields/{field_id}/metadata

Update an existing field’s name and description in the metadata.

Headers

Authorization (required) - Requires the standard authentication header used in the system.

Parameters

  • name Body

    the updated name for your field

  • description Body

    the updated description of what this smart field will be trained to identify

Code Sample 
curl -X PUT -H "Accept: application/json"  
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-d "{
      "name": ["<updated name>"], 
      "description": ["<updated description>"]
    }" 
    https://<base_url>/api/v2/fields/<field_id>/metadata
zdai.fields.update_metadata(field_id=’fieldID’, name=’name’, description=’description)
Response Codes
  • 204 No Content
    the request is successful.
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The field_id does not exist or has been cleaned up.
  • 405 Method Not Allowed
    the field is read-only
  • 500 Internal Server Error
    Something went wrong unrelated to the users request.

Response Data

  • error

    if an error occurs, you may get a standard error response

Need Help?

Couldn’t find the information you were looking for or need more assistance?

Contact us at support@zuva.ai