Update Model

PUT

https://app.polytomic.com/api/models/:id

PUT

/api/models/:id

curl -X PUT https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "configuration": {
    "table": "public.users"
  },
  "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "name": "Users"
}'

{
  "data": {
    "configuration": {
      "table": "public.contacts"
    },
    "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "created_at": "2024-01-15T09:30:00Z",
    "created_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "enricher": {
      "configuration": {},
      "connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "enricher_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "fields": [
        {
          "name": "phone_number"
        }
      ],
      "mappings": {}
    },
    "fields": [
      {
        "created_at": "2024-01-15T09:30:00Z",
        "created_by": {
          "id": "12345678-1234-1234-1234-123456789012",
          "name": "John Doe",
          "type": "user"
        },
        "description": "Unique identifier",
        "example": null,
        "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
        "label": "ID",
        "name": "id",
        "remote_type": "string",
        "type": "string",
        "unique": true,
        "updated_at": "2024-01-15T09:30:00Z",
        "user_added": false
      }
    ],
    "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "identifier": "id",
    "labels": [
      {}
    ],
    "name": "Contacts",
    "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "policies": [
      "248df4b7-aa70-47b8-a036-33ac447e668d"
    ],
    "relations": [
      {
        "from": "id",
        "to": {
          "field": "user_id",
          "model_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
        }
      }
    ],
    "tracking_columns": [
      "string"
    ],
    "type": "postgresql",
    "updated_at": "2024-01-15T09:30:00Z",
    "updated_by": {
      "id": "12345678-1234-1234-1234-123456789012",
      "name": "John Doe",
      "type": "user"
    },
    "version": 1
  },
  "job": {
    "error": "error message",
    "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "result": null,
    "status": "created",
    "type": "createmodel"
  }
}

Updates a model’s configuration.

Updating a model is a full replacement of its configuration. Every field in the request body is written to the model; any field you omit is cleared or reset to its default value.

To make a partial change, fetch the current model with GET /api/models/{id}, modify the fields you want to change, and send the complete object back in the update request.

Changes to source fields, filters, or the identity column take effect on the next sync execution that uses this model.

Authentication

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Model ID

Query parameters

asyncbooleanOptional

Run in the background and return a job instead of the result.

Request

This endpoint expects an object.

configurationmap from strings to anyRequired

Model configuration for the source connection type

connection_idstringRequiredformat: "uuid"

Connection ID of the model's source

namestringRequired

Model name

additional_fieldslist of objects or nullOptional

User-defined fields to add to the model alongside its source fields

enricherobjectOptional

Enrichment to apply to the model

fieldslist of strings or nullOptional

Technical/source field names to publish in the model. Use source names, not model-field UUIDs or display labels. For example, use dealname rather than Deal Name. Omit or pass an empty array to publish all standard source fields.

identifierstringOptional

Source field name of the model's unique identifier

labelslist of strings or nullOptional

organization_idstring or nullOptionalformat: "uuid"

policieslist of strings or nullOptional

Permissions policy IDs applied to the model

refreshbooleanOptional

Whether to refresh the enricher's fields and example values

relationslist of objects or nullOptional

Joins from this model's fields to fields on other models

tracking_columnslist of strings or nullOptional

Source field names used to detect changed records

Response

dataobjectOptional

The model

jobobjectOptional

Background job running the request when async is true

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error