DocumentationNovu Documentation
PlatformGuidesFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

38.7K

Delete a context

Delete a context by its type and id. **type** and **id** are required fields, if the context does not exist, it returns the 404 response

Delete a context by its type and id. type and id are required fields, if the context does not exist, it returns the 404 response

DELETE
/v2/contexts/{type}/{id}

Authorization

Authorization<token>

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

In: header

Path Parameters

idRequiredstring

Context ID

typeRequiredstring

Context type

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

curl -X DELETE "https://api.novu.co/v2/contexts/string/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"
Empty

Update a context PATCH

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

List all contexts GET

Retrieve a paginated list of all contexts, optionally filtered by type and key pattern. **type** and **id** are optional fields, if provided, only contexts with the matching type and id will be returned. **search** is an optional field, if provided, only contexts with the matching key pattern will be returned. Checkout all possible parameters in the query section below for more details

On this page

No Headings
Edit this page on GitHub