OpptyRevenueSchedules.batch_create_or_update

POST

/entities/OpptyRevenueSchedules/batch-modify

Create or update an batch of OpptyRevenueSchedules

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of OpptyRevenueSchedules on change. Use them as bit mask: 0 - validate each field on entity,
2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields,
16 - allows to set entity on deleted relationship.

rollback-method

integer <int32>

optional

Specify rollback method for OpptyRevenueSchedules. 0 - rollback all, 1 - rollback only failed records.

Body Params application / json

array of:

is_deleted

boolean

optional

Specifies if the entity is considered deleted.

Example:

false

cancelation_date

string <date>

optional

Date information.

Example:

2019-01-01

period_count

integer <int32>

optional

Whole natural number.

Example:

period_type

enum<integer>

optional

Integer enum value: 1 - Month, 2 - Quarter, 3 - Year

Allowed values:

123

Example:

start_date

string <date>

optional

Date information.

Example:

2019-01-01

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

string <uuid>

optional

ID of object to update.

Example

[
    {
        "is_deleted": false,
        "cancelation_date": "2019-01-01",
        "period_count": 1,
        "period_type": 1,
        "start_date": "2019-01-01",
        "revision": 1,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/OpptyRevenueSchedules/batch-modify' \
--header 'Content-Type: application / json' \
--data-raw '[
    {
        "is_deleted": false,
        "cancelation_date": "2019-01-01",
        "period_count": 1,
        "period_type": 1,
        "start_date": "2019-01-01",
        "revision": 1,
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
]'

Responses

🟢200OK

application/json

Creation confirmation. Returns a list of created / updated OpptyRevenueSchedules

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array [oneOf]

optional

string <uuid>

optional

And ID of created / updated entity.

object (Error)

optional

Example

{
    "success": true,
    "data": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
}

🔴500Server Error

Modified at 2025-06-26 12:37:59

OpptyRevenueSchedules.batch_delete

OpptyRevenueSchedules.batch_restore