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.

Path Params
string
required

Id of Schema being updated

Query Params
string
Defaults to all

Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.

Body Params
schema
object
Headers
boolean
Defaults to false

When set to true the API will validate the schema update without saving changes

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json