Skip to main content
POST
/
users-organizations
/
v1
/
rs
/
na
/
{userId}
/
invite
Create invite user organization
curl --request POST \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/users-organizations/v1/rs/na/{userId}/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "email": "test@mail.com",
  "scope": 1,
  "permissions": {
    "group": 0,
    "manage": [
      1,
      2
    ],
    "read": [
      1,
      2
    ]
  },
  "professionId": 1
}
'
{
  "data": {
    "userId": 1,
    "organizationId": 1,
    "scope": 1,
    "permissions": {
      "group": 1,
      "read": [
        1,
        2
      ],
      "manage": [
        1,
        2
      ]
    },
    "deletedAt": "2024-12-15T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Body

application/json

Details required to create invite user organization

​
email
string<email>
required

Email of the profile.

Maximum string length: 250
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"test@mail.com"

​
scope
enum<number>
required

Role of the user in the organization.

Available options:
1,
2
Example:

1

​
permissions
object
required
​
professionId
integer

Unique identifier of the profession.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

Response

201 - application/json

The invite user organization has been created

​
data
object
required