Invite user to group

Invite user to group.

Path Parameters

groupId string required

The id of the group.

application/json

Request Body

userId integer

The ID of the user being invited to group.

email string

The email of the user being invited to group.

Responses

Request has been handled successfully.

application/json

Schema

Example (from schema)

Schema

success boolean

data object

message

Possible values: [User has been invited successfully.]

{
  "success": true,
  "data": {}
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

Example

Schema

message string

type string

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

Invite user to group​

Invite user to group