Skip to main content
POST
UpsertContextEntry

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
id
string

Opaque id of the entry. Accepts the bare UUID or the entity_id form (contextentry-<uuid>). The same id updates the same entry, a new id creates a new entry.

Pattern: ^(contextentry-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
text
string | null

The text, in Markdown. Required when creating.

Required string length: 1 - 4096
kind
enum<string> | null

Where a person sees the entry. Required when creating.

Available options:
CONTEXT_ENTRY_KIND_UNSPECIFIED,
CONTEXT_ENTRY_KIND_ANNOUNCEMENT,
CONTEXT_ENTRY_KIND_DESCRIPTION,
CONTEXT_ENTRY_KIND_GUIDANCE
target
entity_id · object

The entities the entry applies to. Required when creating. Omit to keep the existing target on update.

endsAt
string<date-time> | null

Set to end the entry at this time. Omit to keep the existing end time.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"

removeEndsAt
boolean

Set to remove the end time, so the entry does not end. Ignored when ends_at is set.

etag
string | null

Optional optimistic-concurrency guard. When set, the update fails with a conflict if the entry was changed since this etag was read.

actor
Actor · object

Who is performing this write. Optional: the identity is completed from the calling credentials.

Response

200 - application/json

Success

entry
ContextEntry · object

The stored entry after the upsert.