Update designation

put

https://{tenant}.onechurchsoftware.com/api/designations/{id}

Update an existing designation. This is a full update: optional fields that are omitted are cleared (category, campus, posting rules, and keywords), an omitted code is regenerated from the name, and omitted active/taxDeductible become false. First retrieve the current designation from /api/designations/{id}, apply your changes, then send back the full object.

Required permission: Contributions Settings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

≥ 1

The id of the designation

Body Params

The current version of the designation

field

object | null

required

The form field backing the designation. Its label and description hold the designation's name and description; the label is required. Set type to label for a plain designation, or to an input type (e.g. text, dropdown) to show the field to donors as a memo input when they give.

code

string | null

The designation's abbreviation. Must be unique, at most 20 characters. Auto-generated from the name when omitted.

taxDeductible

boolean

Whether contributions to the designation are tax deductible.

active

boolean

Whether the designation is active.

campus

object | null

The campus the designation belongs to, when limited to one. Provide the id; omit to clear. Values come from /api/locations.

category

object | null

The designation's category. Provide the id; omit to clear. Values come from /api/property_values/fund_category/values.

posting

array of objects | null

The accounting posting rules that allocate gifts to accounts and funds. Replaces the existing rules; pass an empty list to stop posting to accounting.

posting

keywords

array of objects | null

The designation's text-giving keywords. Replaces the existing keywords: keywords are matched by id, omitted keywords are removed, and keywords without an id are added.

keywords

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