Create a Partner Event
POST https://api.suger.cloud/ai/org/{orgId}/prm/event
Create an event this organization runs for partners. Required: `title`, `type` (webinar, training, in_person, general), `startDatetime` and `endDatetime` (RFC 3339, start before end), `timezone` (such as America/New_York) and `visibilityType`: `all` partners, `specific` partnerships or one or more partner `tier`s. For specific or tier, list ACTIVE partnership ids (from ListPrmPartnerships; any other status is refused with 400) or tier ids (from GetPrmConfig) in `shareTargetIds`. Optional: `description`, `location`, `meetingUrl`, RSVPs (`isRsvpEnabled`, and a positive `capacity`, which needs `isRsvpEnabled` true), and `status`: draft (the default), published or cancelled. The status does not hide an event: the partners it is shared with see it as soon as it is created, and a cancelled event takes no new RSVPs.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
Request Body
Required. Content-Type: application/json · Schema: CreatePartnerEventRequest
CreatePartnerEventRequest fields:
| Field | Type | Required | Description |
|---|---|---|---|
capacity | integer | no | |
description | string | no | |
endDatetime | string | no | |
isRsvpEnabled | boolean | no | |
location | string | no | |
meetingUrl | string | no | |
shareTargetIds | array<string> | no | ShareTargetIDs are partnership ids (VisibilityType=specific) or tier ids (VisibilityType=tier). One event_visibility row is written per id. |
startDatetime | string | no | |
status | string | no | defaults to "draft" |
timezone | string | no | |
title | string | no | |
type | string | no | |
visibilityType | string | no |
Responses
201 — Created event
Content-Type: application/json · Schema: PartnerEventView
PartnerEventView fields:
| Field | Type | Required | Description |
|---|---|---|---|
attendingCount | integer | no | |
capacity | integer | no | Max attendees as a head count of attending partner_event_rsvp rows; NULL = uncapped. Only meaningful when is_rsvp_enabled=true — handler must reject capacity when RSVP is disabled and enforce the limit transactionally on write. |
createTime | string | no | Creation timestamp |
creatorOrgName | string | no | |
description | string | no | Freeform event description |
endDatetime | string | no | Event end (UTC) |
id | string | no | ID of the ent. Unique event identifier (UUID) |
isRsvpEnabled | boolean | no | Whether partners can RSVP to this event |
lastUpdateTime | string | no | Last update timestamp |
location | string | no | Freeform physical address/venue for in-person/hybrid events; NULL = online-only. Online vs in_person vs hybrid is derived from which of meeting_url/location are set. |
meetingUrl | string | no | Join link for online/hybrid events; NULL = no online component |
organizationId | string | no | Host ISV org that created the event (tenant isolation). |
shareTargetIds | array<string> | no | |
startDatetime | string | no | Event start (UTC) |
status | string | no | draft, published, cancelled. Lifecycle only — 'past' is computed from end_datetime, not stored. |
timezone | string | no | IANA tz name, e.g. America/Vancouver |
title | string | no | Event display name |
type | string | no | webinar, training, in_person, general. |
viewerRsvpStatus | string | no | |
visibilityType | string | no | all (every partner — no partner_event_visibility rows), specific (target_type=partner), tier (target_type=tier) |
400 — Validation error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json
Example
The request bodies are this operation's documented examples; the
response and error bodies are generated from its schema. Substitute your
own ids, and set SUGER_TOKEN to a bearer token from the
OAuth client-credentials exchange.
Request
curl -X POST 'https://api.suger.cloud/ai/org/{orgId}/prm/event' \
-H "Authorization: Bearer $SUGER_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"title": "Q1 partner enablement webinar",
"type": "webinar",
"startDatetime": "2027-01-14T17:00:00Z",
"endDatetime": "2027-01-14T18:00:00Z",
"timezone": "America/Los_Angeles",
"meetingUrl": "https://meet.example.com/q1-enablement",
"visibilityType": "all",
"isRsvpEnabled": true,
"status": "published"
}' Response — 201
{
"attendingCount": 1,
"capacity": 1,
"createTime": "2026-01-31T12:00:00Z",
"creatorOrgName": "Acme Corp",
"description": "string",
"endDatetime": "2026-01-31T12:00:00Z",
"id": "01H0000000000000000000",
"isRsvpEnabled": true,
"lastUpdateTime": "2026-01-31T12:00:00Z",
"location": "string",
"meetingUrl": "https://example.com",
"organizationId": "01H0000000000000000000"
} Error — 400
"string" View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.