Api / Organizations
| Method | Description |
|---|---|
| 🔹 create() | Create organization |
| 🔹 delete() | Delete organization |
| 🔹 logo() | Update logo |
| 🔹 update() | Update organization |
Getting started
// Place your API Key 👇 here
$sdk = new \Kronup\Sdk();
// API Call
$sdk->api()->organizations();
create()
Add an organization owned by the current user
#️⃣ Execute example in terminal
Request
POST
/organizations
Type signature
(new \Kronup\Sdk())->api()->organizations()->create(
\Kronup\Model\PayloadOrganizationCreate $payload_organization_create
): \Kronup\Model\Organization
Parameters
| Name | Type | Description |
|---|---|---|
| $payload_organization_create | \Kronup\Model\PayloadOrganizationCreate |
Return type
delete()
Remove organization
#️⃣ Execute example in terminal
Request
DELETE
/organizations/{orgId}
Type signature
(new \Kronup\Sdk())->api()->organizations()->delete(
string $org_id
): bool
Parameters
| Name | Type | Description |
|---|---|---|
| $org_id | string | Organization ID |
Return type
bool
logo()
Update organization logo
#️⃣ Execute example in terminal
Request
POST
/organizations/{orgId}/logo
Type signature
(new \Kronup\Sdk())->api()->organizations()->logo(
string $org_id,
[ \SplFileObject $logo ]
): \Kronup\Model\Organization
Parameters
| Name | Type | Description |
|---|---|---|
| $org_id | string | Organization ID |
| $logo | \SplFileObject \SplFileObject | Logo - must be a PNG file, exactly 256x256 pixels, smaller than 200KB |
Return type
update()
Update organization details
#️⃣ Execute example in terminal
Request
POST
/organizations/{orgId}
Type signature
(new \Kronup\Sdk())->api()->organizations()->update(
string $org_id,
\Kronup\Model\PayloadOrganizationUpdate $payload_organization_update
): \Kronup\Model\Organization
Parameters
| Name | Type | Description |
|---|---|---|
| $org_id | string | Organization ID |
| $payload_organization_update | \Kronup\Model\PayloadOrganizationUpdate |