OpptyRecurrences.create

POST

/entities/OpptyRecurrences

Lead & Opportunity

Creates new OpptyRecurrence

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of OpptyRecurrence on create. 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.

Body Params application / json

apply_recurrence

boolean

optional

Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply

Example:

false

condition

enum<string>

optional

Bit Flag field, with limited combination of integer values.

Options:
Won = 1 (0b01)
Lost = 2 (0b10) It is required if the recurrence is set. Conditionally generated opportunity as bitwise operation where bit: 1 bit - won 2 bit - loste.g. if the value is 1 => to generate only when opportunity is won.

Allowed values:

Example:

day

enum<integer>

optional

Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31

Allowed values:

12345678910111213141516171819202122232425262728293031

Example:

day_of_week

enum<string>

optional

Bit Flag field, with limited combination of integer values.

Options:
Sunday = 1 (0b0000001)
Monday = 2 (0b0000010)
Tuesday = 4 (0b0000100)
Wednesday = 8 (0b0001000)
Thursday = 16 (0b0010000)
Friday = 32 (0b0100000)
Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute.

Allowed values:

1248163264

Example:

end_date

string <date>

optional

Date information. The last date when no more other items should be created.

Example:

2019-01-01

month

enum<integer>

optional

Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12

Allowed values:

123456789101112

Example:

occur_every

integer <int32>

optional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.
The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.

Example:

occurrences_count

integer <int32>

optional

Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.

Example:

oppty_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

start_date

string <date>

required

Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.

Example:

2019-01-01

step_id

string <uuid>

required

Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step.

Example:

01234567-abcd-dcba-ffff-000000000000

type

enum<integer>

optional

Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears

Allowed values:

012345678910

Example:

week

enum<integer>

optional

Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4

Allowed values:

-11234

Example:

-1

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
  "apply_recurrence": false,
  "condition": 1,
  "day": 1,
  "day_of_week": 1,
  "end_date": "2019-01-01",
  "month": 1,
  "occur_every": 1,
  "occurrences_count": 1,
  "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "start_date": "2019-01-01",
  "step_id": "01234567-abcd-dcba-ffff-000000000000",
  "type": 0,
  "week": -1,
  "revision": 1
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/entities/OpptyRecurrences' \
--header 'Content-Type: application / json' \
--data-raw '{
    "apply_recurrence": false,
    "condition": 1,
    "day": 1,
    "day_of_week": 1,
    "end_date": "2019-01-01",
    "month": 1,
    "occur_every": 1,
    "occurrences_count": 1,
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "start_date": "2019-01-01",
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "type": 0,
    "week": -1,
    "revision": 1
}'

Responses

🟢201Created

application/json

Creation confirmation. Returns created OpptyRecurrence

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OpptyRecurrence)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

oppty

string <uri>

required

Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.

step

string <uri>

optional

Relation to Step. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Step' object for properties.

condition

enum<string>

optional

Bit Flag field, with limited combination of integer values.

Allowed values:

Example:

day

enum<integer>

optional

Allowed values:

12345678910111213141516171819202122232425262728293031

Example:

day_of_week

enum<string>

optional

Bit Flag field, with limited combination of integer values.

Allowed values:

1248163264

Example:

end_date

string <date>

optional

Date information. The last date when no more other items should be created.

Example:

2019-01-01

month

enum<integer>

optional

Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12

Allowed values:

123456789101112

Example:

occur_every

integer <int32>

optional

Example:

occurrences_count

integer <int32>

optional

Example:

oppty_id

string <uuid>

required

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

start_date

string <date>

required

Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.

Example:

2019-01-01

step_id

string <uuid>

required

Relation to single entity instance. Step related to recurrence. A new opportunity will create to this step.

Example:

01234567-abcd-dcba-ffff-000000000000

type

enum<integer>

optional

Allowed values:

012345678910

Example:

week

enum<integer>

optional

Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4

Allowed values:

-11234

Example:

-1

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "oppty": "http://example.com",
    "step": "http://example.com",
    "condition": 1,
    "day": 1,
    "day_of_week": 1,
    "end_date": "2019-01-01",
    "month": 1,
    "occur_every": 1,
    "occurrences_count": 1,
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "start_date": "2019-01-01",
    "step_id": "01234567-abcd-dcba-ffff-000000000000",
    "type": 0,
    "week": -1,
    "revision": 1
  }
}

🔴500Server Error

OpptyRecurrences.list

OpptyRecurrences.batch_delete