Update Model | Polytomic Docs

curl -X PATCH "https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d?async=false" \
     -H "X-Polytomic-Version: X-Polytomic-Version" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -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",
    "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,
    "labels": [
      {}
    ]
  },
  "job": {
    "error": "error message",
    "job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
    "result": null,
    "status": "created",
    "type": "createmodel"
  }
}

Updates a model's configuration.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic 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, which cannot be changed after the model is created

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

organization_idstring or nullOptionalformat: "uuid"

Ignored for user and organization-scoped API keys, which always act in their own organization

policieslist of strings or nullOptional

Permissions policy IDs applied to the model. On update, a non-empty list replaces the model’s policies and an empty or omitted list leaves them unchanged.

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

labelslist of strings or nullOptionalDeprecated

Deprecated; ignored

Response

dataobjectOptional

The model

jobobjectOptional

Background job running the request when async is true

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error