streams

Update the mapping

patch/v1/streams/{streamId}/sources/{sourceId}

Request

  • Base URL: https://postbag.dev
  • URL: https://postbag.dev/v1/streams/{streamId}/sources/{sourceId}
  • Auth: HTTP bearer

Path parameters

streamIdstring required
Example:fm_8f3kq2
sourceIdstring required
Example:fm_8f3kq2

Request body

form_idstring

One Form feeding this Stream. Mutually exclusive with selector.

selectorstring

A dynamic Form source: non-empty tag:<tag> or project:<project_id> without leading or trailing whitespace after :. Mutually exclusive with form_id.

mappingobject

Keyed by the stream schema's field names. Each entry is exactly one of from (copy a field from the form's data), const (a fixed value) or expr (a JSONata expression), plus an optional default. Every required field in the stream's schema must be covered or this call fails 422 mapping_incomplete.

Response

ok

idstring required
form_idstring
selectorstring
mappingobject
mapping_status'valid' | 'incomplete'
missingstring[]
stream_schema_versioninteger

Example response

{
  "id": "fm_8f3kq2",
  "form_id": "fm_8f3kq2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.