Send a user invite

Request

Once a user is created using the userCreate operation, the user needs to setup his/her password.

An invitation needs to be sent to the user in order to be able to set up the password for the first time. The invitation email, which remains valid for 1 month, will contain a URL having all information required to setup the password via the userInviteConsume.

Required user role: ADMIN

Security

apiKey and authToken

Path

user_idstring^[0-9]+$required

The unique identifier for the user.

Example:110747174434373672

idempotency-refstring

A unique call reference generated by the caller that, taking into consideration the payload as well as the operation itself, helps avoid duplicate operations. Idempotency reference uniqueness is maintained for at least 24 hours.

curl -i -X POST \
  https://sandbox.weavr.io/payment-run/v1/users/110747174434373672/invite \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'api-key: YOUR_API_KEY_HERE' \
  -H 'idempotency-ref: string'

Responses

Success - No Content.

Headers

request-refstringrequired

A request identifier. Providing this reference when contacting our support team will help us investigate your query.

Response

No content