Create Contact
Last updated
Last updated
This tutorial should help you create the first Contact. Before moving forward, make sure your Authentication works and you understand the Key Concepts of the Pipeliner API ,and make sure you know how to use API parameters
The Contact represents existing contact from the company, that your company is dealing with. Go to the web Application and Contacts can be located on the Contacts screen. Contact should not be standalone records, but they should always be linked to the Accounts.
Create a Contact in Pipeliner with Job Position/Job Title. This contact will be linked with one Account.
first_name or last_name
Name of the Contact. Name of the Contact is created as "Fist_name" + "Middle_Name" + "Last_Name"
Required: at least one of the first_name, last_name
owner_id
Id of the User in Pipeliner Application
Load an id of the user with the default sales unit. This user will become the owner of the newly created Contact.
We don´t necessarily need to load the default unit id. If only owner_id is specified in the final request, Pipeliner will automatically create contact with the default User´s sales unit. (See step 2. of this tutorial)
We want to assign this contact with an Account. We are going to search for Accounts by email address. But you can use whatever parameter.
Let´s Take data from Step 1. and use them in the following request to create a Contact.
Linking Contact to Account
To Link Contact with Account, we are going to create relation by creating new primary relation in account_relations
array
Setting up the Position
position
- In Pipeliner Application this api_field is called Quick Account Position
. This is the Contact field. Use this field when you are not linking Contact with Account immediately.
account_position
- This is Primary Account Job Title. This position is linked directly with the Account. It is recommended to use this api_field, as Contacts might have different positions on different Accounts.
Possible Errors
Error on field account_relations. Exactly one 'is_primary' item must be set.
Use is_primary flag for Account relation object.
-When creating account relations at least one Account needs to be primary -When creating contact relations at least one Contact needs to be primary
Returns all defined Clients
list of Clients
True when response succeeded, false on error.
true
Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
Creates new contact
data of new Contact
Last modification time.
"2019-01-01T00:00:00"
Creation time.
"2019-01-01T00:00:00"
Relation to CloudObject, see: 'createCloudObjectInput' object for properties.
Multi-line text input field.
"string"
Simple text input field.
"string"
Multi-line text input field.
"string"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields.
"string"
Email address.
"string"
Email address.
"string"
Email address.
"string"
Email address.
"string"
Email address.
"string"
Simple text input field.
"string"
Integer enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary
0
Simple text input field.
"string"
Simple text input field.
"string"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Phone number.
"string"
Phone number.
"string"
Phone number.
"string"
Phone number.
"string"
Phone number.
"string"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Simple text input field.
"string"
Simple text input field.
"string"
Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
0
Simple text input field.
"string"
Simple text input field.
"string"
Relation to single entity instance.
"01234567-abcd-dcba-ffff-000000000000"
Simple text input field.
"string"
Revision when entity was lastly changed.
1
Relation to ContactSocialRelation, see: 'createContactSocialRelationInput' object for properties.
Relations to Accounts.
Relations to SalesUnits.
Relations to Clients.
Relations to CloudObjects.
Job position of Contact in his primary Account or quick account position if Contact has no primary Account.
"string"
If account has any unsubscribed email.
false
Creation confirmation. Returns created contact
True when response succeeded, false on error.
true