This method will update an existing setting with the specified ID.
The updated setting that will be saved.
The contact roles that are allowed to manage this scholarship
If set, policies are shown to users at checkout
If set, you can enable the text of the confirmation email
If set, you can enable the text of the confirmation email
If true, users can retroactively apply coupons to orders in the portal
If set, you can enable the text of the confirmation email
If set, you can enable the text of the shipment email
If true, users in the portal can only retroactively apply coupons to orders within a certain time period
The maximum number of a days after an order is processed that a user can retroactively apply a coupon in the portal
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
- Mock serverhttps://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}
- https://commerce.api.rhythmsoftware.comhttps://commerce.api.rhythmsoftware.com/settings/{tenantId}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"cancellation_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"contact_role_permissions": [
{
"manage_coupon_codes": true,
"role_id": "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": [
{}
]
}
],
"default_ship_from_address": {
"city": "string",
"country": "string",
"country_name": "string",
"county": "string",
"latitude": 0.1,
"line1": "string",
"line2": "string",
"line3": "string",
"longitude": 0.1,
"postal_code": "string",
"state": "string",
"time_zone_id": "string"
},
"default_store_id": "string",
"display_policies_at_checkout": true,
"enable_cancellation_confirmation_email": true,
"enable_order_confirmation_email": true,
"enable_retroactive_coupons_in_portal": true,
"enable_return_confirmation_email": true,
"enable_shipment_confirmation_email": true,
"notes": "string",
"order_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"policies": {
"consumer_data_policy_uri": "string",
"refund_policy_uri": "string",
"secure_checkout_policy_uri": "string",
"terms_of_service_uri": "string"
},
"restrict_retroactive_coupons_by_time_period": true,
"retroactive_coupon_allowed_time_period": 0.1,
"return_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"shipment_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "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_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"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
}'The setting was updated successfully.
The contact roles that are allowed to manage this scholarship
If set, policies are shown to users at checkout
If set, you can enable the text of the confirmation email
If set, you can enable the text of the confirmation email
If true, users can retroactively apply coupons to orders in the portal
If set, you can enable the text of the confirmation email
If set, you can enable the text of the shipment email
If true, users in the portal can only retroactively apply coupons to orders within a certain time period
The maximum number of a days after an order is processed that a user can retroactively apply a coupon in the portal
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
{ "cancellation_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "contact_role_permissions": [ { … } ], "custom_field_values": [ { … } ], "default_ship_from_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "default_store_id": "string", "display_policies_at_checkout": true, "enable_cancellation_confirmation_email": true, "enable_order_confirmation_email": true, "enable_retroactive_coupons_in_portal": true, "enable_return_confirmation_email": true, "enable_shipment_confirmation_email": true, "notes": "string", "order_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "policies": { "consumer_data_policy_uri": "string", "refund_policy_uri": "string", "secure_checkout_policy_uri": "string", "terms_of_service_uri": "string" }, "restrict_retroactive_coupons_by_time_period": true, "retroactive_coupon_allowed_time_period": 0.1, "return_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "shipment_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "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_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "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 }