Contact Workflow Tasks
Contact tasks are used to create, update, and delete Contacts.
Create Contact
task: "Contact/Create@1"
name: createContact
inputs:
values:
accountNumber: "{{ accountNumber }}"
contactFirstName: "{{ contactFirstName }}"
contactLastName: "{{ contactLastName }}"
contactStatusId: "{{ contactStatusId }}"
contactType: "{{ contactType }}"
creditLimit: "{{ creditLimit }}"
customValues: "{{ customValues }}"
divisionId: "{{ divisionId }}"
emailAddress: "{{ emailAddress }}"
entityTypeId: "{{ entityTypeId }}"
faxNumber: "{{ faxNumber }}"
idNumber: "{{ idNumber }}"
idNumberType: "{{ idNumberType }}"
isACorporation: "{{ isACorporation }}"
isDeleted: "{{ isDeleted }}"
mobilePhoneNumber: "{{ mobilePhoneNumber }}"
name: "{{ name }}"
paidAs: "{{ paidAs }}"
paymentTermId: "{{ paymentTermId }}"
phoneNumber: "{{ phoneNumber }}"
tags: "{{ tags }}"
website: "{{ website }}"
outputs:
- name: contact
mapping: "contact"
Get Contact
task: "Contact/Get@1"
name: getContact
inputs:
contactId: "123"
outputs:
- name: contact
mapping: "contact"
Update Contact
task: "Contact/Update@1"
name: updateContact
inputs:
contactId: "123"
values:
accountNumber: "{{ accountNumber }}"
contactFirstName: "{{ contactFirstName }}"
contactLastName: "{{ contactLastName }}"
contactStatusId: "{{ contactStatusId }}"
contactType: "{{ contactType }}"
creditLimit: "{{ creditLimit }}"
customValues: "{{ customValues }}"
divisionId: "{{ divisionId }}"
emailAddress: "{{ emailAddress }}"
entityTypeId: "{{ entityTypeId }}"
faxNumber: "{{ faxNumber }}"
idNumber: "{{ idNumber }}"
idNumberType: "{{ idNumberType }}"
isACorporation: "{{ isACorporation }}"
isDeleted: "{{ isDeleted }}"
mobilePhoneNumber: "{{ mobilePhoneNumber }}"
name: "{{ name }}"
paidAs: "{{ paidAs }}"
paymentTermId: "{{ paymentTermId }}"
phoneNumber: "{{ phoneNumber }}"
tags: "{{ tags }}"
website: "{{ website }}"
Delete Contact
task: "Contact/Delete@1"
name: deleteContact
inputs:
contactId: "123"
Example Contact Workflow
workflow:
name: "Contact / Create Contact Example Workflow"
description: "Create Contact Example Workflow"
version: "1.0"
executionMode: "Sync"
inputs:
- name: "accountNumber"
type: "string"
displayName: "Account number"
description: "Account number"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.accountNumber"
- name: "contactFirstName"
type: "string"
displayName: "Contact first name"
description: "Contact first name"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.contactFirstName"
- name: "contactLastName"
type: "string"
displayName: "Contact last name"
description: "Contact last name"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.contactLastName"
- name: "contactStatusId"
type: "ContactStatus"
displayName: "Contact status id"
description: "Contact status id"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.contactStatusId"
- name: "contactType"
type: "ContactType"
displayName: "Contact type"
description: "Contact type"
multiple: false
required: true
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.contactType"
- name: "creditLimit"
type: "number"
displayName: "Credit limit"
description: "Credit limit"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.creditLimit"
- name: "customValues"
type: "string,string"
displayName: "Custom values"
description: "Custom values"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.customValues"
- name: "divisionId"
type: "Division"
displayName: "Division id"
description: "Division id"
multiple: false
required: true
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.divisionId"
- name: "emailAddress"
type: "string"
displayName: "Email address"
description: "Email address"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.emailAddress"
- name: "entityTypeId"
type: "EntityType"
displayName: "Entity type id"
description: "Entity type id"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.entityTypeId"
- name: "faxNumber"
type: "string"
displayName: "Fax number"
description: "Fax number"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.faxNumber"
- name: "idNumber"
type: "string"
displayName: "Id number"
description: "Id number"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.idNumber"
- name: "idNumberType"
type: "IDNumberType"
displayName: "Id number type"
description: "Id number type"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.idNumberType"
- name: "isACorporation"
type: "boolean"
displayName: "Is a corporation"
description: "Is a corporation"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.isACorporation"
- name: "isDeleted"
type: "boolean"
displayName: "Is deleted"
description: "Is deleted"
multiple: false
required: true
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.isDeleted"
- name: "mobilePhoneNumber"
type: "string"
displayName: "Mobile phone number"
description: "Mobile phone number"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.mobilePhoneNumber"
- name: "name"
type: "string"
displayName: "Name"
description: "Name"
multiple: false
required: true
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.name"
- name: "paidAs"
type: "PaidAs"
displayName: "Paid as"
description: "Paid as"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.paidAs"
- name: "paymentTermId"
type: "PaymentTerm"
displayName: "Payment term id"
description: "Payment term id"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.paymentTermId"
- name: "phoneNumber"
type: "string"
displayName: "Phone number"
description: "Phone number"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.phoneNumber"
- name: "tags"
type: "string"
displayName: "Tags"
description: "Tags"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.tags"
- name: "website"
type: "string"
displayName: "Website"
description: "Website"
multiple: false
required: false
defaultValue: ""
additionalProperties:
visible: true
mapping: "contact.website"
outputs:
- name: contact
mapping: "createContactActivity.createContact.contact"
activities:
- name: "createContactActivity"
description: "Create Contact"
steps:
- task: "Contact/Create@1"
name: createContact
inputs:
contact:
accountNumber: "{{ accountNumber }}"
contactFirstName: "{{ contactFirstName }}"
contactLastName: "{{ contactLastName }}"
contactStatusId: "{{ contactStatusId }}"
contactType: "{{ contactType }}"
creditLimit: "{{ creditLimit }}"
customValues: "{{ customValues }}"
divisionId: "{{ divisionId }}"
emailAddress: "{{ emailAddress }}"
entityTypeId: "{{ entityTypeId }}"
faxNumber: "{{ faxNumber }}"
idNumber: "{{ idNumber }}"
idNumberType: "{{ idNumberType }}"
isACorporation: "{{ isACorporation }}"
isDeleted: "{{ isDeleted }}"
mobilePhoneNumber: "{{ mobilePhoneNumber }}"
name: "{{ name }}"
paidAs: "{{ paidAs }}"
paymentTermId: "{{ paymentTermId }}"
phoneNumber: "{{ phoneNumber }}"
tags: "{{ tags }}"
website: "{{ website }}"
outputs:
- name: contact
mapping: "contact"
- name: "getContactActivity"
description: "Get Contact"
steps:
- task: "Contact/Get@1"
name: getContact
inputs:
contactId: "{{ createContactActivity.createContact.contact.contactId }}"
outputs:
- name: contactFromGet
mapping: "contact"
- name: "updateContactActivity"
description: "Update Contact"
steps:
- task: "Contact/Update@1"
name: updateContact
inputs:
contactId: "{{ getContactActivity.getContact.contact.contactId }}"
contact:
accountNumber: "{{ accountNumber }}"
contactFirstName: "{{ contactFirstName }}"
contactLastName: "{{ contactLastName }}"
contactStatusId: "{{ contactStatusId }}"
contactType: "{{ contactType }}"
creditLimit: "{{ creditLimit }}"
customValues: "{{ customValues }}"
divisionId: "{{ divisionId }}"
emailAddress: "{{ emailAddress }}"
entityTypeId: "{{ entityTypeId }}"
faxNumber: "{{ faxNumber }}"
idNumber: "{{ idNumber }}"
idNumberType: "{{ idNumberType }}"
isACorporation: "{{ isACorporation }}"
isDeleted: "{{ isDeleted }}"
mobilePhoneNumber: "{{ mobilePhoneNumber }}"
name: "{{ name }}"
paidAs: "{{ paidAs }}"
paymentTermId: "{{ paymentTermId }}"
phoneNumber: "{{ phoneNumber }}"
tags: "{{ tags }}"
website: "{{ website }}"
- name: "deleteContactActivity"
description: "Delete Contact"
steps:
- task: "Contact/Delete@1"
name: deleteContact
inputs:
contactId: "{{ getContactActivity.getContact.contact.contactId }}"