organizations.declineInvitation

POST

/v1/invitations/{invitationId}/decline

const url = 'https://example.com/v1/invitations/example/decline';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/v1/invitations/example/decline \
  --header 'Authorization: Bearer <token>'

Says no to an invitation. You need the session cookie and the email of the invitation.

Authorizations

token
session

Parameters

Path Parameters

invitationId

required

string

>= 1 characters <= 128 characters

Responses

200

Success

application/json

object

required

string

>= 1 characters <= 128 characters

organizationId

required

string

organizationName

required

string

email

required

string

roles

required

Array

status

required

string

Allowed values: pending accepted declined revoked expired

invitedBy

required

string

createdAt

required

string

expiresAt

required

string

bot

object

required

string

name

required

string

Example

{
  "roles": [
    "super_administrator"
  ],
  "status": "pending"
}

400

InvitationInvalid

application/json

object

_tag

required

string

Allowed values: InvitationInvalid

message

required

string

Example

{
  "_tag": "InvitationInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

404

InvitationNotFound | RoleNotFound

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: InvitationNotFound

invitationId

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "InvitationNotFound"
}

409

@nmnmcc/ability/Authorizer/Pending

application/json

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

Example

{
  "_tag": "Pending"
}

503

OrganizationStorageUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: OrganizationStorageUnavailable

Example

{
  "_tag": "OrganizationStorageUnavailable"
}