Pipeliner API

Getting access, Developing, Testing

Back to Pipeliner

TextMessageConversations.batch_create_or_update

Create or update an batch of TextMessageConversations

Input

type: object properties: parameters: type: object properties: validation-level: type: integer format: int32 description: >- Specify validation level of TextMessageConversations 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 TextMessageConversations. 0 - rollback all, 1 - rollback only failed records. title: Parameters data: type: array items: properties: phone_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. recipient_account_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. recipient_contact_id: type: string format: uuid example: 01234567-abcd-dcba-ffff-000000000000 description: Relation to single entity instance. recipient_phone_number: type: string example: string description: Phone number. revision: type: integer format: int32 example: 1 description: Revision when entity was lastly changed. messages: type: array description: Relations to TextMessages. items: type: object description: >- Relation to TextMessage, see: 'updateTextMessageInput' object for properties. properties: id: type: string format: uri account_relations: type: array description: Relations to Accounts. items: type: object description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. properties: id: type: string format: uri contact_relations: type: array description: Relations to Contacts. items: type: object description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. properties: id: type: string format: uri project_relations: type: array description: Relations to Projects. items: type: object description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. properties: id: type: string format: uri lead_relations: type: array description: Relations to Leads. items: type: object description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. properties: id: type: string format: uri opportunity_relations: type: array description: Relations to Opportunitys. items: type: object description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' object for properties. properties: id: type: string format: uri quote_relations: type: array description: Relations to Quotes. items: type: object description: >- Relation to TextMessageConversationRelations, see: 'updateTextMessageConversationRelationsInput' 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