Api / Invitations

Method	Description
🔹 accept()	Accept invitation
🔹 create()	Create invitation
🔹 delete()	Delete invitation
🔹 list()	List invitations
🔹 read()	Fetch invitation
🔹 update()	Update invitation

📚 Invitations API Reference

Getting started

// Place your API Key 👇 here
$sdk = new \Kronup\Sdk();

// API Call
$sdk->api()->invitations();

`accept()`

Accept an invitation to join an organization

#️⃣ Execute example in terminal

php -f accept.php

Request

PUT /invitations/{inviteId}

Type signature

(new \Kronup\Sdk())->api()->invitations()->accept(
    string $invite_id
): \Kronup\Model\Invitation

Parameters

Name	Type	Description
$invite_id	string	Invitation ID

Return type

\Kronup\Model\Invitation

🔺 Back to top

`create()`

Create a new invitation to this organization

#️⃣ Execute example in terminal

php -f create.php

Request

POST /invitations

Type signature

(new \Kronup\Sdk())->api()->invitations()->create(
    \Kronup\Model\PayloadInvitationCreate $payload_invitation_create
): \Kronup\Model\Invitation

Parameters

Name	Type	Description
$payload_invitation_create	\Kronup\Model\PayloadInvitationCreate

Return type

\Kronup\Model\Invitation

🔺 Back to top

`delete()`

Delete invitation

#️⃣ Execute example in terminal

php -f delete.php

Request

DELETE /invitations/{inviteId}

Type signature

(new \Kronup\Sdk())->api()->invitations()->delete(
    string $invite_id
): bool

Parameters

Name	Type	Description
$invite_id	string	Invitation ID

Return type

bool

🔺 Back to top

`list()`

Get a list of invitation models

#️⃣ Execute example in terminal

php -f list.php

Request

GET /invitations

Type signature

(new \Kronup\Sdk())->api()->invitations()->list(
    [ int $page_number = 1, ]
    [ int $page_size = 500 ]
): \Kronup\Model\InvitationsList

Parameters

Name	Type	Description
$page_number	int	[default to 1]
$page_size	int	[default to 500]

Return type

\Kronup\Model\InvitationsList

🔺 Back to top

`read()`

Retrieve invitation model

#️⃣ Execute example in terminal

php -f read.php

Request

GET /invitations/{inviteId}

Type signature

(new \Kronup\Sdk())->api()->invitations()->read(
    string $invite_id
): \Kronup\Model\Invitation

Parameters

Name	Type	Description
$invite_id	string	Invitation ID

Return type

\Kronup\Model\Invitation

🔺 Back to top

`update()`

Update invitation details

#️⃣ Execute example in terminal

php -f update.php

Request

POST /invitations/{inviteId}

Type signature

(new \Kronup\Sdk())->api()->invitations()->update(
    string $invite_id,
    \Kronup\Model\PayloadInvitationUpdate $payload_invitation_update
): \Kronup\Model\Invitation

Parameters

Name	Type	Description
$invite_id	string	Invitation ID
$payload_invitation_update	\Kronup\Model\PayloadInvitationUpdate

Return type

\Kronup\Model\Invitation

🔺 Back to top