Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Report a chat profile

Reports a message, image or user to the moderation queue.

Reports a message, image or user to the moderation queue.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:report
  • Scope events:write
  • Effect write — a successful call changes state.
  • Collection chat_profiles

#Request

FieldTypeWhat it is
namestringReporting user's profile. Required.
target_typestringmessage, image or user.
target_idstringFull message name, image SHA-256 or user id.
reasonstringReport reason.

#Response

FieldTypeWhat it is
namestringResource name.
uidstringStable identifier. Output only.
metaResourceMetaResource metadata.
reporter_idstringReporting member. Output only.
target_typestringmessage, image or user. Output only.
target_idstringFull message name, image SHA-256 or user id respectively. Output only.
reasonstringReport reason. Output only.
statusstringpending, resolved or dismissed. Output only.
due_timetimestampLatest response time for the moderation queue. Output only.

#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.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/chat_profiles/chat-profile:report" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'