docs/UsersApi.md in purecloudplatformclientv2-10.0.0 vs docs/UsersApi.md in purecloudplatformclientv2-11.0.0

- old
+ new

@@ -37,10 +37,11 @@ [**patch_user_queue**](UsersApi.html#patch_user_queue) | Join or unjoin a queue for a user [**patch_user_queues**](UsersApi.html#patch_user_queues) | Join or unjoin a set of queues for a user [**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates [**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details [**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations +[**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user [**post_user_routingskills**](UsersApi.html#post_user_routingskills) | Add routing skill to user [**post_users**](UsersApi.html#post_users) | Create user [**post_users_search**](UsersApi.html#post_users_search) | Search users [**put_user_callforwarding**](UsersApi.html#put_user_callforwarding) | Update a user&#39;s CallForwarding [**put_user_outofoffice**](UsersApi.html#put_user_outofoffice) | Update an OutOfOffice @@ -1954,9 +1955,71 @@ ### Return type [**ObservationQueryResponse**](ObservationQueryResponse.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="post_user_invite"></a> + +## - post_user_invite(user_id, opts) + +Send an activation email to the user + + + +Wraps POST /api/v2/users/{userId}/invite + + +### Example +~~~ruby +# load the gem +require 'purecloudplatformclientv2' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::UsersApi.new + +user_id = "user_id_example" # String | User ID + +opts = { + force: false # BOOLEAN | Resend the invitation even if one is already outstanding +} + +begin + #Send an activation email to the user + api_instance.post_user_invite(user_id, opts) +rescue PureCloud::ApiError => e + puts "Exception when calling UsersApi->post_user_invite: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **String**| User ID | | + **force** | **BOOLEAN**| Resend the invitation even if one is already outstanding | [optional] [default to false] | +{: class="table table-striped"} + + +### Return type + +nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json