POST/sites/$site/invites/new

Invite one or more users to your site.

Resource Information


Method	POST
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/invites/new
Requires authentication?	No

Method Parameters

Parameter	Type	Description
$site	(int\|string)	Site ID or domain.

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
invitees	(string\|array)	List of email addresses or wpcom users names to invite.
role	(string)	The role of the invitees on the blog.
message	(string)	A message that will be appended to the invitation email.
source	(string)	Optional. The source of the follow e.g. calypso
is_external	(bool)	Optional. Whether to mark the user or users as external contributors to the blog.

Response Parameters

Parameter	Type	Description
sent	(array)	A list of email addresses or wpcom usernames that were successfully invited
errors	(array)	A list of email address or wpcom usernames that were not invited. Formatted as $username_or_email => WP_Error

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode 'invitees=Array' \
 --data-urlencode 'role=author' \
 --data-urlencode 'message=Howdy folks. Please join my blog.' \
 'https://public-api.wordpress.com/rest/v1.1/sites/$blog_id/invites/new'

<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
      1 => 'Content-Type: application/x-www-form-urlencoded',
    ),
    'content' => 
     http_build_query(  array (
        'invitees' => 
        array (
          0 => 'wpcomusername1',
          1 => 'wpcomusername2',
          2 => 'user1@example.com',
          3 => 'user2@example.com',
        ),
        'role' => 'author',
        'message' => 'Howdy folks. Please join my blog.',
      )),
  ),
);

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