Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

Opportunities.batch_create_or_update

Create or update an batch of Opportunities

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of Opportunities 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: type: integer format: int32 description: >- Specify rollback method for Opportunities. 0 - rollback all, 1 - rollback only failed records. title: Parameters data: type: array items: properties: created: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: Creation time. active_quote_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. closing_date: type: string format: date example: '2019-01-01T00:00:00.000Z' description: Closing date of the Opportunity. description: type: string example: string description: Multi-line text input field. is_archived: type: boolean example: false description: Boolean value. is_value_auto_calculate: type: boolean example: false description: Boolean value. label_flag: type: string example: 1 enum: - 1 - 2 - 4 description: |- Opportunity label flag. Options: Priority = 1 (0b001) Hot = 2 (0b010) Stalled = 4 (0b100) name: type: string example: string description: Name of the entity and its default text representation. oppty_type_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. owner_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. product_currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. product_price_list_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. product_sections: type: object description: Product sections on Opportunity in json format quick_account_email: type: string example: string description: Simple text input field. quick_account_name: type: string example: string description: Simple text input field. quick_account_phone: type: string example: string description: Simple text input field. quick_contact_name: type: string example: string description: Simple text input field. quick_email: type: string example: string description: Simple text input field. quick_phone: type: string example: string description: Simple text input field. ranking: type: integer format: int32 example: 1 description: Qualitative ranking of the opportunity. reason_of_close_description: type: string example: string description: Multi-line text input field. reason_of_close_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. share_mode: type: integer description: >- Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit example: 0 enum: - 0 - 1 - 2 - 3 step_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. unit_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. was_qualified: type: boolean example: false description: Boolean value. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. value: type: object required: - base_value - currency_id - value_foreign description: Monetary value in a foreign currency. properties: base_value: type: number format: double example: '4.32' description: Currency. currency_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. value_foreign: type: number format: double example: '4.32' description: Decimal number. oppty_recurrence: type: object description: >- Relation to OpptyRecurrence, see: 'updateOpptyRecurrenceInput' object for properties. properties: id: type: string format: uri revenue_schedule: type: object description: >- Relation to OpptyRevenueSchedule, see: 'updateOpptyRevenueScheduleInput' object for properties. properties: id: type: string format: uri product_relations: type: array description: Relations to Products. items: type: object description: >- Relation to OpptyProductRelation, see: 'updateOpptyProductRelationInput' object for properties. properties: id: type: string format: uri contact_relations: type: array description: Relations to Contacts. items: type: object description: >- Relation to LeadOpptyContactRelation, see: 'updateLeadOpptyContactRelationInput' object for properties. properties: id: type: string format: uri account_relations: type: array description: Relations to Accounts. items: type: object description: >- Relation to LeadOpptyAccountRelation, see: 'updateLeadOpptyAccountRelationInput' object for properties. properties: id: type: string format: uri documents: type: array description: Relations to CloudObjects. items: type: object description: >- Relation to CloudObjectRelation, see: 'updateCloudObjectRelationInput' object for properties. properties: id: type: string format: uri quote_relations: type: array description: Relations to Quotes. items: type: object description: 'Relation to Quote, see: ''updateQuoteInput'' object for properties.' properties: id: type: string format: uri won_date: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: '' lost_date: type: string format: date-time example: '2019-01-01T00:00:00.000Z' description: '' sharing_units: type: array description: Relations to SalesUnits. items: type: object description: >- Relation to LeadOpptySharingSalesUnitRelation, see: 'updateLeadOpptySharingSalesUnitRelationInput' object for properties. properties: id: type: string format: uri sharing_clients: type: array description: Relations to Clients. items: type: object description: >- Relation to LeadOpptySharingClientRelation, see: 'updateLeadOpptySharingClientRelationInput' object for properties. properties: id: type: string format: uri tags: type: array description: Relations to Tags. items: type: object description: >- Relation to TagRelation, see: 'updateTagRelationInput' object for properties. properties: id: type: string format: uri id: description: ID of object to update. type: string format: uuid type: object title: Data

Output

type: object properties: success: type: boolean example: true description: True when response succeeded, false on error. data: type: array items: oneOf: - type: string description: And ID of created / updated entity. format: uuid - properties: http_status: description: HTTP status code type: integer example: 400 code: description: Internal API error code type: integer example: 117 name: description: Name of the API error type: string example: ERROR_PARAMETER_INVALID message: description: Description of the API error type: string success: description: Always false on error. type: boolean example: false required: - success - http_status