API - Planyo Web Services - add_url_to_admin_favorites

You are here: Planyo » Help » API » add_url_to_admin_favorites

add_url_to_admin_favorites

Description:

Adds an easily-accessible favorite page to the backend of all the moderators and admins of a site or just for a specific user. This is the equivalent of clicking on the star icon on the title of any backend page

Input:

url string required
Relative URL of the page to be added to user favorites, e.g. pricing-rules.php and not https://planyo.com/pricing-rules.php
title string required
Title of the favorite
user_id int optional
Pass this parameter if the favorite should be personal for one of the site admins or moderators
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

none

API playground:

Click here to test this function in the API playground.