Skip to main content
POST
/
api
/
v1
/
organization-invitations
/
curl --request POST \
  --url https://api.main.apexscore.ai/api/v1/organization-invitations/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "organization_id": "e8e912b6-ba9b-4c3a-bb4f-d04bdc370843",
  "email": "user@example.com",
  "first_name": "Member",
  "last_name": "Person",
  "role": 0
}'
{
  "sent": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expiry_date": "2023-11-07T05:31:56Z",
      "status": 0,
      "organization": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "inviter_member": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "jsmith@example.com"
      },
      "email": "jsmith@example.com",
      "first_name": "<string>",
      "last_name": "<string>",
      "email_sent": true,
      "role": 0,
      "accessible_portfolios": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ]
    }
  ],
  "failed": []
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
organization_id
string<uuid>
required
​
email
string<email>
required

Invitee's email address.

Maximum length: 255
​
status
enum<integer>

Status of the invitation, default status is pending.

  • 0 - pending
  • 1 - accepted
  • 2 - cancelled
  • 3 - expired
  • 4 - revoked
Available options:
0,
1,
2,
3,
4
​
first_name
string | null

Invitee's first name.

Maximum length: 25
​
last_name
string | null

Invitee's last name.

Maximum length: 25
​
role
enum<integer>

Invitee's role, default role is member.

  • 0 - member
  • 1 - collaborator
  • 2 - administrator
Available options:
0,
1,
2
​
accessible_portfolio_ids
string<uuid>[]

Response

​
sent
object[]
required
​
failed
any[]