Skip to main content
POST
/
admin
/
invitations
Create Invitation
curl --request POST \
  --url https://psn-api.paystub.dev/admin/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role_id": 123,
  "email": "[email protected]",
  "first_name": "<string>",
  "last_name": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": 123,
    "role": {
      "id": 123,
      "name": "Owner"
    },
    "inviter": {
      "id": 123,
      "name": "<string>"
    },
    "email": "[email protected]",
    "first_name": "<string>",
    "last_name": "<string>",
    "full_name": "<string>",
    "token": "<string>",
    "status": "pending",
    "accepted_at": "2023-11-07T05:31:56Z",
    "expires_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Use your API token

Body

application/json
role_id
integer
required
email
string<email>
required
first_name
string
required
last_name
string
required

Response

201 - application/json

Invitation created successfully

success
boolean
Example:

true

data
object