Invites

>>>

GET /api/v2/invites
List of workspace invites

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "invites": [],
  "my_invites": [
    {
      "id": 2,
      "name": "scrumLaunch team",
      "email": "kruchina.vadim+1@gmail.com",
      "state": "pending",
      "created_at": "2022-01-07T21:39:11.637Z",
      "sender_email": "kruchina.vadim@gmail.com"
    }
  ]
}
>>>

GET /api/v2/invites/:id
Checking for existence of an invite. Last update: 03/08/23

Success response body ↑

{
  "success": true,
  "data": {
    "id": 50,
    "state": "pending",
    "created_at": "2023-07-21T13:03:57.226Z",
    "user": {
      "id": 94,
      "email": "kruchina.vadim+1@gmail.com",
      "first_name": null,
      "last_name": null
    },
    "sender": {
      "id": 1,
      "email": "kruchina.vadim@gmail.com",
      "first_name": "11",
      "last_name": "1"
    },
    "workspace": {
      "id": 1,
      "name": "1",
      "organization_type": "Club/Youth Sports",
      "workspace_logo": {
        "id": 25,
        "s3_key": null,
        "format_type": null
      }
    }
  }
}

Params

Param name Description
id
required

Current invite ID

Validations:

  • Must be a Integer
>>>

POST /api/v2/invites
Create invite to workspace

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "user_emails": [
    "sample_email@gmail.com",
    ...
  ],
  location: guidedWalkthrough
}

Success response body ↑

{
  "successfully_invited_users": [
    "kruchina.vadim+3@gmail.com",
    ...
  ],
  "already_invited_users": [
    "kruchina.vadim+2@gmail.com",
    ...
  ],
  "already_on_workspace": [
    "kruchina.vadim+1@gmail.com",
    ...
  ],
  "workspace": {
    "id": 1,
    "name": "Scrum Launch",
    "available_users_count": 30,
    "can_add_new_users": true,
    "can_invite_users_count": 29,
    "workspace_roles": [
      {
        "id": 1,
        "name": "super_admin",
        "users": [
          {
            "id": 1,
            "first_name": "Vadim",
            "last_name": "Kruchina",
            "email": "kruchina.vadim@gmail.com",
            "avatar_image": null,
            "invite_status": "acceped",
            "invite_id": 1
          }
        ]
      },
      {
        "id": 2,
        "name": "creative_admin",
        "users": []
      },
      {
        "id": 3,
        "name": "creator",
        "users": []
      },
      {
        "id": 4,
        "name": "editor",
        "users": [
          {
            "id": 2,
            "first_name": "Vadim",
            "last_name": "Kruchina",
            "email": "kruchina.vadim+1@gmail.com",
            "avatar_image": null,
            "invite_status": "pending",
            "invite_id": 1
          }
        ]
      }
    ]
  }
}

Params

Param name Description
user_emails
required

Array of user emails

Validations:

  • Must be an array of String
location
optional

Validations:

  • Must be one of: workspaceSettingsPage, signUpForm, guidedWalkthrough, progressMeter, templateBranding.
>>>

DELETE /api/v2/invites/:id
Delete invite

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": 1,
  "name": "Scrum Launch",
  "available_users_count": 30,
  "can_add_new_users": true,
  "can_invite_users_count": 29,
  "workspace_roles": [
    {
      "id": 1,
      "name": "super_admin",
      "users": [
        {
          "id": 1,
          "first_name": "Vadim",
          "last_name": "Kruchina",
          "email": "kruchina.vadim@gmail.com",
          "avatar_image": null,
          "invite_status": "acceped",
          "invite_id": 1
        }
      ]
    },
    {
      "id": 2,
      "name": "creative_admin",
      "users": []
    },
    {
      "id": 3,
      "name": "creator",
      "users": []
    },
    {
      "id": 4,
      "name": "editor",
      "users": [
        {
          "id": 2,
          "first_name": "Vadim",
          "last_name": "Kruchina",
          "email": "kruchina.vadim+1@gmail.com",
          "avatar_image": null,
          "invite_status": "pending",
          "invite_id": 1
        }
      ]
    }
  ]
}

Params

Param name Description
id
required

Current invite ID

Validations:

  • Must be a Integer
>>>

GET /api/v2/invites/:id/resend_email
Resend invite`s email

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": "true"
}

Params

Param name Description
id
required

Current invite ID

Validations:

  • Must be a Integer
>>>

PUT /api/v2/invites/:id/accept
Accept invite

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "notice": "Invite was successfully accepted."
}

Params

Param name Description
id
required

Current invite ID

Validations:

  • Must be a Integer
>>>

PUT /api/v2/invites/:id/decline
Decline invite

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "notice": "Invite was successfully declined."
}

Params

Param name Description
id
required

Current invite ID

Validations:

  • Must be a Integer