> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateRecipient # Package: onlineOrders # Namespace: NotificationRecipientsService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/restaurants/online-orders/notification-recipients/update-recipient.md ## Permission Scopes: Manage Restaurants - all permissions: SCOPE.RESTAURANTS.MEGA-SCOPES ## Introduction Updates a recipient's information. Each time the recipient is updated, `revision` increments by 1. The current `revision` must be passed when updating the recipient. This ensures you're working with the latest recipient and prevents unintended overwrites. --- ## REST API ### Schema ``` Method: updateRecipient Description: Updates a recipient's information. Each time the recipient is updated, `revision` increments by 1. The current `revision` must be passed when updating the recipient. This ensures you're working with the latest recipient and prevents unintended overwrites. URL: https://www.wixapis.com/rest-notification-recipients/v1/recipients/{recipient.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: recipient, recipient.id, recipient.revision Method parameters: param name: recipient | type: Recipient | required: true - name: id | type: string | description: Recipient GUID. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient. Ignored when creating a Recipient. | required: true - name: phone | type: string | description: Recipient's phone number for receiving notifications. - name: businessLocationIds | type: array | description: IDs of the business locations this recipient should receive order creation notifications for. If this list is empty the recipient receives notifications for orders created at all locations. - name: channels | type: array | description: Communication channels for sending notifications to the recipient. At least 1 channel is required. Recipients can receive notifications through multiple channels simultaneously. - enum: - SMS: Send notifications via SMS text messages. - PHONE: Send notifications via phone calls. - name: note | type: string | description: Additional information about the recipient. Use this field to store notes about the recipient's role, availability, or other relevant details for notification management. - name: extendedFields | type: ExtendedFields | description: Additional custom fields for the recipient. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags for categorizing and organizing recipients. Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. Return type: UpdateRecipientResponse - name: recipient | type: Recipient | description: Updated recipient. - name: id | type: string | description: Recipient GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient. Ignored when creating a Recipient. - name: createdDate | type: string | description: Date and time the Recipient was created. - name: updatedDate | type: string | description: Date and time the Recipient was last updated. - name: phone | type: string | description: Recipient's phone number for receiving notifications. - name: businessLocationIds | type: array | description: IDs of the business locations this recipient should receive order creation notifications for. If this list is empty the recipient receives notifications for orders created at all locations. - name: channels | type: array | description: Communication channels for sending notifications to the recipient. At least 1 channel is required. Recipients can receive notifications through multiple channels simultaneously. - enum: - SMS: Send notifications via SMS text messages. - PHONE: Send notifications via phone calls. - name: note | type: string | description: Additional information about the recipient. Use this field to store notes about the recipient's role, availability, or other relevant details for notification management. - name: extendedFields | type: ExtendedFields | description: Additional custom fields for the recipient. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags for categorizing and organizing recipients. Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. ``` ### Examples ### UpdateRecipient ```curl ~~~cURL curl -X PATCH \ 'https://www.wixapis.com/restaurants/v1/recipients/12345678-1234-1234-1234-123456789012' \ -H 'Content-Type: application/json' \ -H 'Authorization: ' \ -d '{ "recipient": { "id": "12345678-1234-1234-1234-123456789012", "revision": 1, "phone": "+1-555-987-6543", "channels": ["SMS"] } }' ~~~ ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.onlineOrders.NotificationRecipientsService.updateRecipient(_id, recipient) Description: Updates a recipient's information. Each time the recipient is updated, `revision` increments by 1. The current `revision` must be passed when updating the recipient. This ensures you're working with the latest recipient and prevents unintended overwrites. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: recipient, _id, recipient.revision Method parameters: param name: _id | type: string | description: Recipient GUID. | required: true param name: recipient | type: UpdateRecipient | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient. Ignored when creating a Recipient. | required: true - name: phone | type: string | description: Recipient's phone number for receiving notifications. - name: businessLocationIds | type: array | description: IDs of the business locations this recipient should receive order creation notifications for. If this list is empty the recipient receives notifications for orders created at all locations. - name: channels | type: array | description: Communication channels for sending notifications to the recipient. At least 1 channel is required. Recipients can receive notifications through multiple channels simultaneously. - enum: - SMS: Send notifications via SMS text messages. - PHONE: Send notifications via phone calls. - name: note | type: string | description: Additional information about the recipient. Use this field to store notes about the recipient's role, availability, or other relevant details for notification management. - name: extendedFields | type: ExtendedFields | description: Additional custom fields for the recipient. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags for categorizing and organizing recipients. Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. Return type: PROMISE - name: _id | type: string | description: Recipient GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the Recipient is updated. To prevent conflicting changes, the current revision must be passed when updating the Recipient. Ignored when creating a Recipient. - name: _createdDate | type: Date | description: Date and time the Recipient was created. - name: _updatedDate | type: Date | description: Date and time the Recipient was last updated. - name: phone | type: string | description: Recipient's phone number for receiving notifications. - name: businessLocationIds | type: array | description: IDs of the business locations this recipient should receive order creation notifications for. If this list is empty the recipient receives notifications for orders created at all locations. - name: channels | type: array | description: Communication channels for sending notifications to the recipient. At least 1 channel is required. Recipients can receive notifications through multiple channels simultaneously. - enum: - SMS: Send notifications via SMS text messages. - PHONE: Send notifications via phone calls. - name: note | type: string | description: Additional information about the recipient. Use this field to store notes about the recipient's role, availability, or other relevant details for notification management. - name: extendedFields | type: ExtendedFields | description: Additional custom fields for the recipient. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: tags | type: Tags | description: Tags for categorizing and organizing recipients. Use tags to group recipients by role (manager, kitchen staff), shift (morning, evening), or other criteria for targeted notifications. - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors. - name: tagIds | type: array | description: List of tag GUIDs. - name: publicTags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. ``` ### Examples ### updateRecipient ```javascript import { recipients } from '@wix/restaurants'; async function updateRecipient(_id,recipient) { const response = await recipients.updateRecipient(_id,recipient); }; ``` ### updateRecipient (with elevated permissions) ```javascript import { recipients } from '@wix/restaurants'; import { auth } from '@wix/essentials'; async function myUpdateRecipientMethod(_id,recipient) { const elevatedUpdateRecipient = auth.elevate(recipients.updateRecipient); const response = await elevatedUpdateRecipient(_id,recipient); } ``` ### updateRecipient (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { recipients } from '@wix/restaurants'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { recipients }, // Include the auth strategy and host as relevant }); async function updateRecipient(_id,recipient) { const response = await myWixClient.recipients.updateRecipient(_id,recipient); }; ``` ---