Fundraising
/
Pledge Levels
/
Partially updates a pledge level with the specified ID.

Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description
fundraising-v1.json
fundraising-v1.yaml
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/
https://fundraising.api.rhythmsoftware.com/

Appeals

Appeals

Operations

Billing Templates

Billing Templates

Operations

Campaigns

Campaigns

Operations

Donor Clubs

Donor Clubs

Operations

Donor Levels

Donor Levels

Operations

Donor Statement Templates

Donor Statement Templates

Operations

Donor Statements

Donor Statements

Operations

Donors

Donors

Operations

Fund Categories

Fund Categories

Operations

Funds

Funds

Operations

Gift Notices

Gift Notices

Operations

Gifts

Gifts

Operations

Giving Processes

Giving Processes

Operations

Pledge Levels

Pledge Levels

Operations

Gets all of the pledge levels in the system.

Request

This method will scan all pledge levels and and return them to the caller.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledgeLevels/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The pledge levelswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

]
Response
application/json
[
  {
    "amount_per_payment": "string",
    "custom_field_values": [ … ],
    "display_order": 0.1,
    "id": "string",
    "name": "string",
    "number_of_payments": 0.1,
    "payment_frequency": "annual",
    "processing_day": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [ … ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": "string"
  }
]

Creates a new pledge level record that does not already exist.

Request

This method will auto-generate an ID and create a new pledge level. If an ID is specified for the pledge level, an error will be thrown.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The pledge level that you would like to be saved.

amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledgeLevels/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount_per_payment": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "display_order": 0.1,
    "id": "string",
    "name": "string",
    "number_of_payments": 0.1,
    "payment_frequency": "annual",
    "processing_day": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": "string"
  }'

Responses

The pledge level was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

Response
application/json
{
  "amount_per_payment": "string",
  "custom_field_values": [
    { … }
  ],
  "display_order": 0.1,
  "id": "string",
  "name": "string",
  "number_of_payments": 0.1,
  "payment_frequency": "annual",
  "processing_day": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": "string"
}

Returns a pledge level from the system by its ID.

Request

This method will delete a pledge level with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the pledge level to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledgeLevels/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The pledge level was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a pledge level from the system by its ID.

Request

This method will look up a pledge level by the specified ID and return it back.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the pledge level to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledgeLevels/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The pledge level was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

Response
application/json
{
  "amount_per_payment": "string",
  "custom_field_values": [
    { … }
  ],
  "display_order": 0.1,
  "id": "string",
  "name": "string",
  "number_of_payments": 0.1,
  "payment_frequency": "annual",
  "processing_day": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": "string"
}

Partially updates a pledge level with the specified ID.

Request

This method will patch an existing pledge level with the specified ID, using the HTTP PATCH specification.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the pledge level to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledgeLevels/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The pledge level was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

Response
application/json
{
  "amount_per_payment": "string",
  "custom_field_values": [
    { … }
  ],
  "display_order": 0.1,
  "id": "string",
  "name": "string",
  "number_of_payments": 0.1,
  "payment_frequency": "annual",
  "processing_day": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": "string"
}

Updates a pledge level with the specified ID.

Request

This method will update an existing pledge level with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the pledge level to update.

Bodyapplication/jsonrequired

The updated pledge level that will be saved.

amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledgeLevels/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount_per_payment": "string",
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "display_order": 0.1,
    "id": "string",
    "name": "string",
    "number_of_payments": 0.1,
    "payment_frequency": "annual",
    "processing_day": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "total": "string"
  }'

Responses

The pledge level was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
amount_per_paymentstring(Amount Per Payment)

The amount each payment can be

custom_field_valuesArray of objects(Custom Field Values)
display_ordernumber(float)(Display Order)

The order in which to display the pledge level

idstring(ID)/^[\w:|-]+$/required

The unique, string identifier of this pledge level

namestring(Name)required

The name of the pledge level

number_of_paymentsnumber(float)(Number Of Payments)

The number of payment in this pledge level

payment_frequencystring(Payment Frequency)
Enum"annual""monthly""quarterly"
processing_daystring(Processing Day)

The day of the month on which to process payments

sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

totalstring(Total)

Total pledge amount for the pledge level

Response
application/json
{
  "amount_per_payment": "string",
  "custom_field_values": [
    { … }
  ],
  "display_order": 0.1,
  "id": "string",
  "name": "string",
  "number_of_payments": 0.1,
  "payment_frequency": "annual",
  "processing_day": "string",
  "sys_bulk_load_at": "string",
  "sys_bulk_load_id": "string",
  "sys_bulk_load_pk": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_calculated_field_error": "string",
  "sys_calculated_field_errors": [
    { … }
  ],
  "sys_configuration_snapshot_id": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_deleted_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_has_files_in_s3": true,
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_last_security_context": {},
  "sys_locked": true,
  "sys_snapshot_base_version": 0.1,
  "sys_version": 0.1,
  "total": "string"
}

Pledge Notices

Pledge Notices

Operations

Pledges

Pledges

Operations

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations