POST /me/settings/profile-links/new

Add a link to current user's profile.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/me/settings/profile-links/new
Requires authentication? No

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Request Parameters

Parameter Type Description
value (string) The profile link to add to the current user.
title (string) Description of the profile link.

Response Parameters

Parameter Type Description
success (bool) Was the link successfully added to the current user's profile?
title (string) The description of the link added.
value (string) The link added itself.
link_slug (string) The slug of the new profile link.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 duplicate_link An identical profile link already exists.
403 authorization_required An active access token must be used to save information about the current user.
401 reauthorization_required A fresh access token must be used to query information about the current user.

Example

curl 'https://public-api.wordpress.com/rest/v1.1/me/settings/profile-links/new'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1.1/me/settings/profile-links/new',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "success": true,
    "link_slug": "httpwordpress-com"
}