INinfomaniak
User Management

Invite a User

Changed on

Create and send an invitation for a new or existing User to join an Account using an email address.

post/1/accounts/{account}/invitations

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/accounts/{account}/invitations
  • Auth
    HTTP bearer

Path parameters

accountinteger required

Unique identifier of the Account

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

Request body

emailstring required

The email address of the user being invited.

first_namestring required

The first name of the user being invited.

last_namestring required

The last name of the user being invited.

locale'de_DE' | 'en_GB' | 'es_ES' | 'fr_FR' | 'it_IT' required

The locale code for the language of the invitation the user will receive.

passwordstring required
role_type'admin' | 'normal' | 'owner' required

The role to assign to the user upon invitation.

silentboolean

Whether or not the user will receive the invitation email. (default: false)

strictboolean

Whether or not the user should register with the same email address. (default: true)

teamsinteger[]

The teams the user should be added to upon invitation.

Response

Created

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success",
  "data": {
    "language_id": 1,
    "locale": "fr_FR",
    "sent_at": 1745062007,
    "url_accept": "https://welcome.infomaniak.com/invitation/account/1234567890987654321?lang=fr"
  }
}

Changes

  • 8c78546bf41fRevision changes
    • breaking

      added the new required request property

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status