Skip to content
Console
On this page

Create a support inbox

Creates an idempotent SupportInbox; changed replay and illegal state are refused.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Creates an idempotent SupportInbox; changed replay and illegal state are refused.

Not available yet. This method answers 501 with the problem code UNIMPLEMENTED.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_inboxes
  • Scope notify:support:configure
  • Effect write — a successful call changes state.
  • Collection support_inboxes
  • Query support_inbox_id, request_id, validate_only
  • Validate-only validate_only=true runs every check and writes nothing

Request

FieldTypeWhat it is
parentstringAuthenticated parent scope. Required.
support_inboxSupportInboxRecord to admit; actor and output fields are derived by the service. Required.
support_inbox_idstringOptional caller-selected platform ID; legacy IDs stay in source_records.
request_idstringUUID request identity, stable across transport retries.
validate_onlyboolValidate without admitting a case, message or effect.

SupportInbox

FieldTypeWhat it is
namestringThe canonical resource name.
metaResourceMetaLabels, annotations, display name, timestamps and strong ETag.
localesstring[]Supported BCP 47 locales; the language is still decided per message. Required.
channelsSupportChannel[]Verified links to existing transport resources, not transport credentials.
policystringTenant-policy API resource; rule tables and remedy budgets remain there. Required.
intake_bounddurationMaximum allowed delay from a received event to committed case intake. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

SupportChannel

FieldTypeWhat it is
idstringStable channel-link identity within the inbox. Required.
uidstringImmutable source identity of this configuration record.
display_namestringHuman-readable channel label.
transportstringPublic transport resource or authenticated ingress endpoint. Required.
allowed_originsstring[]Exact canonical origins; an empty list never means wildcard browser access.
anonymous_allowedboolWhether platform-issued anonymous sessions may enter this browser channel.
enabledboolWhether new intake is admitted; disabling never drops accepted events.
labelsmap<string, string>Source metadata, not an authorization mechanism.
annotationsmap<string, string>Unindexed source annotations.
versionint64Configuration revision, independent of case and delivery versions.
create_timetimestampOriginal creation time.
update_timetimestampLast configuration change.
kindstringChannel class: browser, email, social or product; credentials stay external.

Response

FieldTypeWhat it is
namestringThe canonical resource name.
uidstringImmutable platform identity; never substitutes for a source case ID. Output only.
metaResourceMetaLabels, annotations, display name, timestamps and strong ETag.
localesstring[]Supported BCP 47 locales; the language is still decided per message. Required.
channelsSupportChannel[]Verified links to existing transport resources, not transport credentials.
policystringTenant-policy API resource; rule tables and remedy budgets remain there. Required.
intake_bounddurationMaximum allowed delay from a received event to committed case intake. Required.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

SupportChannel

FieldTypeWhat it is
idstringStable channel-link identity within the inbox. Required.
uidstringImmutable source identity of this configuration record.
display_namestringHuman-readable channel label.
transportstringPublic transport resource or authenticated ingress endpoint. Required.
allowed_originsstring[]Exact canonical origins; an empty list never means wildcard browser access.
anonymous_allowedboolWhether platform-issued anonymous sessions may enter this browser channel.
enabledboolWhether new intake is admitted; disabling never drops accepted events.
labelsmap<string, string>Source metadata, not an authorization mechanism.
annotationsmap<string, string>Unindexed source annotations.
versionint64Configuration revision, independent of case and delivery versions.
create_timetimestampOriginal creation time.
update_timetimestampLast configuration change.
kindstringChannel class: browser, email, social or product; credentials stay external.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_inboxes" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"intake_bound":{},"locales":["…"],"policy":"…"}'