BusinessRedirections
Update BusinessRedirection
Update an existing BusinessRedirection record.
PUT
Update BusinessRedirection
Updates an existing BusinessRedirection record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the BusinessRedirection-Edit role.Request Body
Required Fields
The Id of the BusinessRedirection record to update.
ID of the business linked to this record.
Source URL path to redirect from.
Destination URL to redirect to.
Optional Fields
Whether the redirect is currently active.
Date and time from which the redirect becomes active.
Date and time after which the redirect is no longer active.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the businessredirection was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update BusinessRedirection