POST/users/{userId}/send-invitation-email

Resends an invitation message to a pending member. The host who invites members in the resent invitation message is the administrator.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

user
directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/send-invitation-email

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
usePrivateEmail boolean 

Indicates whether to send an invitation message to the member's personal email address. If it is "true", the member's personal email address is required.


required
default : false 
email string 

It is required if usePrivateEmail is "false".


maxLength : 256 

Request Example

example

1{2  "usePrivateEmail": true3}

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found