wizehive.people.invite

Invite an exisiting person to a workspace, or create a new person and invite them to a workspace.

Authentication

This method requires authentication.

Arguments

api_key

(Required)
Your API application key. See here for more details.

email

(Required, if no

res_id

)
The email address of the person.

ws_id

(Required, if no

res_id

)
The workspace id for the person.

res_id

(Required, if no

email

)
The id of the person to invite.

note

(Optional)
A message to be included in the invitation.

Example Response

This method has no specific response - It returns an empty success response if it completes without error.

Error Codes

1: No resouce id/email address

One of the required parameters

email

or

res_id

was not found.

2: Resource not found

Could not find the person with corresponding

res_id

.

3: No resouce id/workspace id

One of the required parameters

ws_id

or

res_id

was not found.

96: Invalid signature

The passed signature was invalid.

98: Login failed / Invalid auth token

The login details or auth token passed were invalid.

99: User not logged in / Insufficient permissions

The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.

100: Invalid API Key

The API key passed was not valid or has expired.

112: Method "xxx" not found

The requested method was not found.