Update a context

Update the data of an existing context. type and id are required fields, data is required. Only the data field is updated, the rest of the context is not affected. If the context does not exist, it returns the 404 response

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

In: header

Request Body

application/jsonRequired

dataRequiredobject

Custom data to associate with this context. Replaces existing data.

Path Parameters

idRequiredstring

Context ID

typeRequiredstring

Context type

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

typeRequiredstring

Context type (e.g., tenant, app, workspace)

idRequiredstring

Unique identifier for this context

dataRequiredobject

Custom data associated with this context

createdAtRequiredstring

Creation timestamp

updatedAtRequiredstring

Last update timestamp

export interface Response {
  /**
   * Context type (e.g., tenant, app, workspace)
   */
  type: string;
  /**
   * Unique identifier for this context
   */
  id: string;
  /**
   * Custom data associated with this context
   */
  data: {
    [k: string]: unknown;
  };
  /**
   * Creation timestamp
   */
  createdAt: string;
  /**
   * Last update timestamp
   */
  updatedAt: string;
}

curl -X PATCH "https://api.novu.co/v2/contexts/string/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "tenantName": "Acme Corp",
      "region": "us-east-1",
      "settings": {
        "theme": "dark"
      }
    }
  }'