setCustomSlug( )

Sets a new active slug for the service.

The call fails if at least one of these conditions is met:

  • The slug doesn't adheres to the supported format.
  • Another service is currently using the slug.
  • Another service has used the slug in the past.
Authentication

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

Permissions
Manage Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
function setCustomSlug(
  serviceId: string,
  options: SetCustomSlugOptions,
): Promise<SetCustomSlugResponse>;
Method Parameters
serviceIdstringRequired

ID of the service for which to update the active slug.

optionsSetCustomSlugOptions
Returns
Return Type:Promise<SetCustomSlugResponse>
JavaScript
import { services } from "@wix/bookings";

async function setCustomSlug(serviceId, options) {
  const response = await services.setCustomSlug(serviceId, options);
}
Errors
400Invalid Argument

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.

Did this help?