PATCH

Update Sender Details


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a sender.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Access Verticals by Automations
Set Up Automations
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/sender-details/v1/sender-details/{senderDetails.id}

Path Params
senderDetails.idstringRequired

Sender details ID.

Body Params
senderDetailsSenderDetailsRequired

Sender details to update.

Response Object
senderDetailsSenderDetails

The updated sender details.

Update Sender Details Example 1
Request
cURL
curl -X PATCH 'https://www.wixapis.com/sender-details/v1/sender-details/3dcaeca5-2b09-441c-86ab-808d85061511' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "senderDetails": { "fromName": "Johnny Doe", "fromEmailAddress": "john.doe@example.com" } }'
Response
JSON
{ "senderDetails": { "id": "3dcaeca5-2b09-441c-86ab-808d85061511", "createdDate": "2024-01-01T00:00:00.000Z", "updatedDate": "2024-01-02T00:00:00.000Z", "fromName": "Johnny Doe", "fromEmailAddress": "john.doe@example.com", "default": true } }
Errors
409Already Exists

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?