Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Designation

updateDesignation

Update specified Designation

put/designations/{designation}

Path parameters

designationinteger required
Example:34672

Primary identifier of Designation

Request body

citystring nullable

The name of the city associated with the Designation

descriptionstring nullable

A brief description of the Designation

end_datestring date-time nullable

Date that record ends

end_timestring date-time nullable

Time that record ends

external_reference_idstring nullable

Primary identifier of associated Member

goalstring float nullable

The Fundraising Goal for the Designation

is_activeboolean

Indicates whether Designation is active

is_completeboolean

Indicates whether Designation is complete

is_defaultboolean

Indicates whether this is the default Designation for the Organization. Only one Designation per Organization can have this be true

namestring

Name of the Designation, unique to this Organization

postal_codestring nullable

Postal code associated with the Designation

start_datestring date-time

Date that record starts

start_timestring date-time

Time that record starts

statestring nullable

Two-letter abbreviation of the state associated with the Designation

Example request

{
  "city": "San Diego",
  "description": "My Designation Description",
  "end_date": "2021-04-23T08:23:21Z",
  "end_time": "2021-04-23T08:23:21Z",
  "external_reference_id": "my_unique_identifier",
  "goal": "1000.0",
  "is_active": true,
  "name": "My Designation Name",
  "postal_code": "90210",
  "start_date": "2021-04-23T08:23:21Z",
  "start_time": "2021-04-23T08:23:21Z",
  "state": "CA"
}

Response

Success

citystring nullable

The name of the city associated with the Designation

created_atstring date-time

Date/time of initial record creation

descriptionstring nullable

A brief description of the Designation

end_timestring nullable

Date/time that record ends

external_reference_idstring nullable

Primary identifier of associated Member

goalstring float nullable

The fundraising goal for the Designation

idinteger

Primary identifier of record

is_activeboolean

Indicates whether Designation is active

is_completeboolean

Indicates whether Designation is complete

is_defaultboolean

Indicates whether this is the default Designation for the organization. Only one Designation per Organization can have this be true

namestring nullable

Name of the Designation, unique to this Organization

organization_idinteger

Primary identifier of associated Organization

postal_codestring nullable

Postal code associated with the Designation

start_timestring nullable

Date/time that record starts

statestring nullable

Two-letter abbreviation of the state associated with the Designation

updated_atstring date-time

Date/time of last record update

Example response

{
  "city": "San Diego",
  "created_at": "2021-04-23T08:23:21Z",
  "description": "My Designation Description",
  "end_time": "2021-04-23 08:23:21",
  "external_reference_id": "my_unique_identifier",
  "goal": "1000.0",
  "id": 34672,
  "is_active": true,
  "name": "My Designation Name",
  "organization_id": 82364,
  "postal_code": "90210",
  "start_time": "2021-04-23 08:23:21",
  "state": "CA",
  "updated_at": "2021-04-23T10:25:03Z"
}