Monetate Data API
Schema

Update an Existing Schema

PATCH
https://api.monetate.net/api/data/v1/{retailerShortname}/production/schema/{schema-name}/

Update an existing schema by either adding new columns or updating the Identifier Name.

The request differs based on whether adding new columns or updating Identifier Name Must only supply either fields or named_identifier (but not both) in the params body. Response will return either fields or named_identifier, depending on which was supplied.

Authentication
Authorization
Path Parameters
schema-name
*
Body Parameters
body
Example
{"name":"catalog","type":"event","fields":{"new_field":{"data_type":"STRING"}}}
Description
Within a Schema, fields must have unique names. Columns passed in the fields property are added to the schema.
fields
*
Responses
200
Schema patched. Content is the definition of the modified Schema.
meta
*
data
*
400
Validation error. One or more values being sent was not in the correct format, or a required value was missing.
meta
*
data
*
401
Unauthorized. The request did not include a token, or the token provided was invalid. Please ensure that your token is correct and that the Authorization header is properly formatted.
meta
*
data
*
403
Forbidden. The request included a token that has been revoked. Please contact your account administrator to generate a new token.
meta
*
data
*
500
Unknown error. Please try again or contact your account manager for more information.
meta
*
data
*




Updated 17 Dec 2024
PREVIOUS
Delete a Schema
NEXT
List Schema Types
Docs powered by Archbee