Skip to main content
PATCH
/
api
/
v1
/
organization-invitations
/
{id}
/
Partial Update
curl --request PATCH \
  --url https://api.main.apexscore.ai/api/v1/organization-invitations/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "accessible_portfolio_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "token": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "expiry_date": "2023-11-07T05:31:56Z",
  "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",
  "email_sent": true,
  "accessible_portfolios": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "first_name": "<string>",
  "last_name": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this organization invitation.

Body

application/json
​
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
Required range: -2147483648 <= x <= 2147483647
​
organization_id
string<uuid>
write-only
​
email
string<email>

Invitee's email address.

Maximum string length: 255
​
first_name
string | null

Invitee's first name.

Maximum string length: 25
​
last_name
string | null

Invitee's last name.

Maximum string length: 25
​
role
enum<integer>

Invitee's role, default role is member.

  • 0 - member
  • 1 - collaborator
  • 2 - administrator
Available options:
0,
1,
2
Required range: -2147483648 <= x <= 2147483647
​
accessible_portfolio_ids
string<uuid>[]
write-only

Response

200 - application/json
​
id
string<uuid>
required
read-only
​
token
string<uuid>
required
read-only

Token is used to validate the invitation.

​
expiry_date
string<date-time>
required
read-only

Date is calculated in save().

​
organization
object
required
​
inviter_member
object
required
​
email
string<email>
required

Invitee's email address.

Maximum string length: 255
​
email_sent
boolean
required
read-only
​
accessible_portfolios
object[]
required
read-only
​
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
Required range: -2147483648 <= x <= 2147483647
​
first_name
string | null

Invitee's first name.

Maximum string length: 25
​
last_name
string | null

Invitee's last name.

Maximum string length: 25
​
role
enum<integer>

Invitee's role, default role is member.

  • 0 - member
  • 1 - collaborator
  • 2 - administrator
Available options:
0,
1,
2
Required range: -2147483648 <= x <= 2147483647