diff --git a/content/reference.mdx b/content/reference.mdx index f4bf2007..c6566d9a 100644 --- a/content/reference.mdx +++ b/content/reference.mdx @@ -310,7 +310,7 @@ Resources that return multiple entities support the same cursor-based pagination /> @@ -585,29 +585,30 @@ The workflow trigger endpoint enforces the following payload size limits: @@ -675,27 +676,28 @@ The workflow trigger endpoint enforces the following payload size limits: @@ -761,6 +763,7 @@ The workflow cancellation endpoint enforces the following payload size limits: name="cancellation_key" type="string" description="The cancellation key unique to the trigger call" + isRequired /> @@ -1290,7 +1293,7 @@ Returns a `404 Not Found` error for a message outside the account's retention wi /> @@ -1432,7 +1435,7 @@ Returns a `404 Not Found` error for a message outside the account's retention wi @@ -1761,42 +1764,42 @@ For in-app channels, messages can be updated indefinitely via this operation. Fo @@ -2048,37 +2051,37 @@ along with a user token to make this request** /> @@ -2103,14 +2106,15 @@ A user represents an individual who may need to receive a notification from Knoc name="id" type="string" description="Unique identifier for the user" + isRequired /> - - - - + + + + The locale of the user. Used for @@ -2121,7 +2125,7 @@ A user represents an individual who may need to receive a notification from Knoc /> @@ -2226,29 +2230,21 @@ Identifying a user will create or update a user in Knock, merging the properties ### Body parameters - - + + The locale of the user. Used for @@ -2259,7 +2255,7 @@ Identifying a user will create or update a user in Knock, merging the properties /> @@ -2276,13 +2272,13 @@ Identifying a user will create or update a user in Knock, merging the properties /> @@ -2482,63 +2478,63 @@ Messages outside the account's retention window will not be included in the resu /> @@ -2667,6 +2663,7 @@ Merges the two users together, merging the user specified in the `from_user_id` name="from_user_id" type="string" description="Unique identifier of the user to merge from" + isRequired /> @@ -2716,6 +2713,7 @@ Identifies up to 1000 users at a time. Returns a `BulkOperation` that executes t type="User[]" description="A list of users to upsert" typeSlug="#users" + isRequired /> @@ -2774,6 +2772,7 @@ Deletes up to 1000 users at a time. Returns a `BulkOperation` that executes the name="user_ids" type="string[]" description="Unique identifiers of the users to delete" + isRequired /> @@ -2832,7 +2831,7 @@ when sending [Slack notifications](/integrations/slack). /> The locale of the object. Used for @@ -2843,7 +2842,7 @@ when sending [Slack notifications](/integrations/slack). /> @@ -3118,63 +3117,63 @@ Messages outside the account's retention window will not be included in the resu /> @@ -3271,7 +3270,7 @@ Sets an object within a collection, performing an upsert operation. Any existing The locale of the object. Used for @@ -3282,7 +3281,7 @@ Sets an object within a collection, performing an upsert operation. Any existing /> @@ -3300,13 +3299,13 @@ Sets an object within a collection, performing an upsert operation. Any existing /> @@ -3424,6 +3423,7 @@ Bulk sets up to 1000 objects at a time within a collection. Returns a `BulkOpera name="objects[].id" type="string" description="The id of the object to set." + isRequired /> @@ -3865,10 +3866,11 @@ Adds one or more recipients as subscribers to the object by creating subscriptio type="RecipientIdentifier[]" description="A list of recipient identifiers. You can subscribe up to 100 recipients to an object at a time." typeSlug="/concepts/recipients#recipientidentifier-definition" + isRequired /> @@ -3947,6 +3949,7 @@ Returns a `BulkOperation` that executes the job asynchronously. Progress can be name="subscriptions" type="AddSubscriptionsOp[]" description="A list of subscriptions to create. Each entry represents a set of Recipients to subscribe to an Object." + isRequired /> @@ -4040,6 +4043,7 @@ Removes one or more recipients as subscribers to the object. type="RecipientIdentifier[]" description="A list of recipient identifiers" typeSlug="/concepts/recipients#recipientidentifier-definition" + isRequired /> @@ -4742,6 +4746,7 @@ Please note: This is a destructive operation and will replace any existing users name="user_ids" type="string[]" description="A list of user ids to set preferences for" + isRequired /> + @@ -5138,13 +5149,13 @@ A schedule allows you to automatically trigger a workflow at a given time for on description="A list of one or more repeat definitions that determine when this schedule should run." /> @@ -5246,8 +5257,9 @@ Returns a paginated list of schedules in descending order. /> @@ -6005,6 +6024,7 @@ If no user exists in the current environment for the given :user_id, Knock will .

} + isRequired /> @@ -6179,6 +6199,7 @@ If no object exists in the current environment for the given :collection and :ob .

} + isRequired /> @@ -7178,6 +7199,7 @@ Adds members to an audience. The same user can be added to the audience multiple name="members" type="object[]" description="Members to add to the audience. The `tenant` field is optional. Max length is 1000." + isRequired /> @@ -7256,6 +7278,7 @@ Removes members from an audience. If a member was added with a tenant ID, that t name="members" type="object[]" description="Members to remove from the audience. The `tenant` field is optional. Max length is 1000." + isRequired /> diff --git a/content/send-notifications/canceling-workflows.mdx b/content/send-notifications/canceling-workflows.mdx index 5f56464d..e115972a 100644 --- a/content/send-notifications/canceling-workflows.mdx +++ b/content/send-notifications/canceling-workflows.mdx @@ -26,11 +26,11 @@ You can read about generating workflow cancellation keys and some best practices ### Schema -| Property | Type | Description | -| ---------------- | --------------------- | ------------------------------------------------------------------------------ | -| key\* | string | The human readable key of the workflow from the Knock dashboard | -| cancellation_key | string | A unique identifier for the workflow run | -| recipients | RecipientIdentifier[] | A list of specific recipient identifiers to cancel the workflow for (optional) | +| Property | Type | Description | +| ------------------ | --------------------- | ------------------------------------------------------------------------------ | +| key\* | string | The human readable key of the workflow from the Knock dashboard | +| cancellation_key\* | string | A unique identifier for the workflow run | +| recipients | RecipientIdentifier[] | A list of specific recipient identifiers to cancel the workflow for (optional) | ## Canceling for subsets of recipients