Update form entry

put

https://{tenant}.onechurchsoftware.com/api/forms/{form}/entries/{entry}

Update an existing form entry. Responses are updated per field: a response for a known field replaces the stored value, fields not included are left unchanged, and file fields cannot be edited. Required fields cannot be cleared. First retrieve the current entry from /api/forms/{form}/entries/{entry}, apply your changes, then send back the full object. Administrator-only fields are updated only when you have the Limited Write Forms permission.

Required permission: Full Write Forms

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

form

int32

required

≥ 1

The id of the form the entry is for.

entry

int32

required

≥ 1

The id of the entry.

Body Params

The new version of the entry

guest

int32 | null

The id of the event guest record created by the sign-up, when the entry is an event sign-up. On update, provide together with status to change the guest's RSVP status.

status

object | null

The reservation status, when the entry is an event sign-up. On update, the status code to set for the guest (defaults to going when omitted).

responses

array of objects | null

The entry's responses, one per answered field.

responses

person

object | null

The submitter's profile information as captured by the entry.

event

int32 | null

The id of the event the entry signed up for, when linked. On create, the form must be the sign-up form configured for the event.

group

int32 | null

The id of the group the entry signed up for, when linked. On create, the form must be the sign-up form configured for the group.

position

int32 | null

The id of the volunteer position the entry signed up for, when linked. On create, the form must be the sign-up form configured for the position.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

404Not Found