Add Catalog Attributes

You can use this API to add new attributes to the catalog. If the API request contains attributes that already exist, they will not be added again.

PATCH /catalog/{catalog_id}/attributes

Add Catalog Attributes

cURL

curl --request PATCH \
  --url https://api-{dc}.moengage.com/v1/catalog/{catalog_id}/attributes \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    {
      "name": "color",
      "type": "string"
    },
    {
      "name": "weight_kg",
      "type": "double"
    }
  ]
}
'

202

{
  "success": true,
  "duplicate-item-attributes": [
    "colour",
    "weight"
  ]
}

Rate Limit Information

Request limit - 100/min OR 1000/hr. Payload size limit - 5MB only when Content-Length header is provided.

Authorizations

Authorization · string · header · required

Basic Authentication sends a Base64-encoded string containing your username and password.

You can obtain the username and password from the MoEngage Dashboard:

1. Navigate to Settings > Account > APIs.
2. Username: Copy the Workspace ID.
3. Password: Copy the Catalog API key.

Path Parameters

catalog_id · string · required

The unique identifier for the catalog, obtained during catalog creation.

Body

application/json

attributes · object[] · required

A list of new attributes to add to the catalog schema.

Show child attributes

Response

202

application/json

Accepted. The request was processed. The response contains a list of attributes that were already present and ignored.

success · boolean

Example:

true

duplicate-item-attributes · string[]

A list of attributes that already existed in the catalog and were ignored.

Example:

["colour", "weight"]