Update a schema

Make an update to a given schema.

To delete a schema field, reference the field delete endpoint: https://developers.activecampaign.com/reference/delete-a-field-1

Users are encouraged to leverage the ?showFields=all query parameter when programmatically creating new schema fields, to ensure field id uniqueness. Fields that have been deleted will contain a status: marked_for_deletion attribute.

{
  "schema": {
    "slug": "stripe-order",
    "labels": {
      "singular": "Stripe Order",
      "plural": "Stripe Orders"
    },
    "description": "Orders placed through the Stripe integration",
    "appId": "123456",
    "fields": [
      {
        "id": "name",
        "labels": {
          "singular": "Product Name",
          "plural": "Product Name"
        },
        "description": "Name of the product from the Stripe integration",
        "isRequired": true,
        "origin": "stripe",
        "type": "text"
      },
      {
        "id": "total",
        "labels": {
          "singular": "Order Total",
          "plural": "Order Totals"
        },
        "description": "Total cost of the order",
        "isRequired": true,
        "origin": "stripe",
        "type": "currency",
        "defaultCurrency": "USD"
      },
      {
        "id": "status",
        "labels": {
          "singular": "Order Status",
          "plural": "Order Statuses"
        },
        "description": "Status of the order",
        "isRequired": true,
        "origin": "stripe",
        "type": "dropdown",
        "options": [
          {
            "value": "Processed"
          }
        ]
      },
      {
        "id": "features",
        "labels": {
          "singular": "Order Feature",
          "plural": "Order Features"
        },
        "description": "Extra features for the order",
        "isRequired": true,
        "origin": "stripe",
        "type": "multiselect",
        "options": [
          {
            "value": "Expedited Shipping"
          }
        ]
      },
      {
        "id": "rating",
        "labels": {
          "singular": "Order Rating",
          "plural": "Order Ratings"
        },
        "description": "Customer satisfaction rating",
        "isRequired": true,
        "origin": "stripe",
        "type": "decimal",
        "scale": 2
      }
    ],
    "icons": {
      "default": "https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png"
    },
    "relationships": [
      {
        "id": "primary-contact",
        "labels": {
          "singular": "Primary Contact",
          "plural": "Primary Contacts"
        },
        "description": "Products purchased in this Stripe order",
        "namespace": "contacts",
        "hasMany": false
      }
    ]
  }
}
{
  "schema": {
    "id": "schema-9999-9999",
    "slug": "stripe-order",
    "labels": {
      "singular": "Stripe Order",
      "plural": "Stripe Orders"
    },
    "description": "Orders placed through the Stripe integration",
    "appId": "123456",
    "fields": [
      {
        "id": "name",
        "labels": {
          "singular": "Product Name",
          "plural": "Product Name"
        },
        "description": "Name of the product from the Stripe integration",
        "isRequired": true,
        "origin": "stripe",
        "type": "text"
      },
      {
        "id": "total",
        "labels": {
          "singular": "Order Total",
          "plural": "Order Totals"
        },
        "description": "Total cost of the order",
        "isRequired": true,
        "origin": "stripe",
        "type": "currency",
        "defaultCurrency": "USD"
      },
      {
        "id": "status",
        "labels": {
          "singular": "Order Status",
          "plural": "Order Statuses"
        },
        "description": "Status of the order",
        "isRequired": true,
        "origin": "stripe",
        "type": "dropdown",
        "options": [
          {
            "id": "264d3b73-069e-4ca1-b270-dbfa3137b541",
            "value": "Processed"
          }
        ]
      },
      {
        "id": "features",
        "labels": {
          "singular": "Order Feature",
          "plural": "Order Features"
        },
        "description": "Extra features for the order",
        "isRequired": true,
        "origin": "stripe",
        "type": "multiselect",
        "options": [
          {
            "id": "041ef416-a85b-678f-4a15-5dd481dad123",
            "value": "Expedited Shipping"
          }
        ]
      },
      {
        "id": "rating",
        "labels": {
          "singular": "Order Rating",
          "plural": "Order Ratings"
        },
        "description": "Customer satisfaction rating",
        "isRequired": true,
        "origin": "stripe",
        "type": "decimal",
        "scale": 2
      }
    ],
    "icons": {
      "default": "https://activehosted.com/temp-placeholder.svg"
    },
    "relationships": [
      {
        "id": "primary-contact",
        "labels": {
          "singular": "Primary Contact",
          "plural": "Primary Contacts"
        },
        "description": "Products purchased in this Stripe order",
        "namespace": "contacts",
        "hasMany": false
      }
    ],
    "createdTimestamp": "2021-04-13T21:12:53.390Z",
    "updatedTimestamp": "2021-04-13T21:12:53.390Z"
  }
}
Language
Authorization
Header
URL