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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
serviceIdstringRequired

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

optionsSetCustomSlugOptions
Returns
Return Type:Promise<SetCustomSlugResponse>
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?