incomingEvents.update

Change it; enabled: true switches it on once the sample is in.

Prerequisites

A Curviate API key, passed as apiKey when you construct the client. Quickstart shows how to create one.

Signature

update(id: string, body: IncomingEventUpdateBody): Promise<IncomingEvent>

Example

import { Curviate } from "@curviate/sdk";
 
const curviate = new Curviate({
  apiKey: "cvt_live_...",
  baseUrl: "https://api.curviate.com",
});
 
await curviate.incomingEvents.update("inc_123", { enabled: true });

Parameters

Name	Type	Required	Description
`id`	`string`	Yes	Incoming event id (inc_...).
`event_name`	`string`	No	Fixed event name every post carries, e.g. reply_received. Exactly one of event_name and event_name_field.
`event_name_field`	`string`	No	Path in the post the event name is read from (trimmed, lowercased), e.g. event_type.
`motion_id`	`string`	No	Only this Motion's Enrollments move. null: any Motion's.
`match`	`object`	No	Up to three paths, tried in this order: the first that finds a Contact wins. null removes one.
`required_header`	`object`	No	A header every post must carry, else 401. null removes it.
`enabled`	`boolean`	No	Switch on (needs a sample and a match path) or off.

Returns

Resolves to IncomingEvent. Top-level fields: object, id, url, event_name, event_name_field, event_names_seen, motion_id, match, required_header, enabled, sample_state, shape, last_arrival_at, arrivals_7d, used_by, created_by, created_at, previous_url_valid_until.

Error codes

Code	What it means, and what to do
`UNAUTHORIZED`	The API key is missing, malformed, or revoked. Check the key you passed to the client.
`INVALID_REQUEST`	A parameter failed validation. The message names the offending field; fix the request rather than retrying it.
`RATE_LIMIT_ACCOUNT`	This account's own quota is exhausted. Wait for the window in the `Retry-After` header, then retry.
`RATE_LIMIT_TENANT`	The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call.
`PLATFORM_RATE_LIMIT`	LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account.
`PLATFORM_ERROR`	An upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries `retry_likely_to_succeed: false` and `retry_hint: {kind: "never"}`, retrying cannot help and backing off only delays the real answer.
`NO_ACTIVE_SEAT`	The targeted account is not on an active seat. Buy or attach a seat in Billing, then retry.
`PAYLOAD_TOO_LARGE`	Three limits can trigger this. The platform's own ceiling on total request size is the lowest and the one you are most likely to hit: it starts rejecting at roughly 1 MB, so a handful of photo-sized images is refused even though it clears everything below. Above that, this API caps one attachment at 5 MiB of file content and the whole request body at 9 MiB. Attachments travel base64-encoded, which inflates them by about a third, so a 5 MiB file costs roughly 6.7 MiB of the body budget. Send fewer or smaller attachments; retrying unchanged will not help.
`RESOURCE_NOT_FOUND`	The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it.
`TEAM_REQUIRED`	See the error codes reference.

Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.

Next steps

incomingEvents.list: The Team's incoming events (url masked); event keeps one event name.
incomingEvents.get: One incoming event, url masked; shape is the captured sample as paths and types only.
incomingEvents.arrivals: The last 20 posts and what each did (outcome; accept values you do not know), kept 30 days.
SDK Quick Start: installation, the client, account scoping, and pagination.