HIhightouch

Update Model

Changed on

Update an existing model

Patch a model based on its Hightouch ID

patch/models/{modelId}

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Path parameters

modelIdnumber double required

The model's ID

Request body

namestring

The name of the model

descriptionstring nullable

The description of the model. Null when no description has been set.

isSchemaboolean

If is_schema is true, the model is just used to build other models. Either as part of visual querying, or as the root of a visual query.

folderIdstring
primaryKeystring

The primary key will be null if the query doesn't get directly synced (e.g. a relationship table for visual querying)

Response

Ok

OR
OR
'Internal Server Error' required

Changes

  • 5574262d4032Revision changes
    • breaking

      the response property //// became nullable for the status

    • info

      added the new optional request property

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

  • 5d508533e9bbRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status