Add Catalog Attributes

This API adds 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' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "attributes": [
    {
      "name": "color",
      "type": "string"
    },
    {
      "name": "weight_kg",
      "type": "double"
    },
    {
      "name": "sale_start_date",
      "type": "datetime"
    },
    {
      "name": "store_location",
      "type": "geopoint"
    }
  ]
}
'

202

new-attribute-added

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

Rate Limit

• Request limit: You can add 100 attributes per minute OR 1000 attributes per hour.

• Payload size limit - 5 MB only when Content-Length header is provided.

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

• Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
• Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY · string · required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

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:

["pricing"]