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
/entities/Clients
if enabled, deleted Clients are returned as well
Number of entities to return from beginning of the result set. Max: 100. Default: 30
Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.
Cursor until which to take entities to result set.
Cursor after which to start taking entities to result set.
Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.
expand=owner,sales_unit,account_relations.accountOrder by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.
order-by=created,-modifiedUse name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.
filter[name]=ExampleFilter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].
filter-op[name]=eqLoads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.
load-only=id,name,owner.idCreates new contact
/entities/Contacts
Specify validation level of contact 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.
Last modification time.
2019-01-01T00:00:00Creation time.
2019-01-01T00:00:00Multi-line text input field.
stringSimple text input field.
stringMulti-line text input field.
stringRelation to single entity instance.
01234567-abcd-dcba-ffff-000000000000Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields.
stringEmail address.
stringEmail address.
stringEmail address.
stringEmail address.
stringEmail address.
stringSimple text input field.
stringSimple text input field.
stringSimple text input field.
stringRelation to single entity instance.
01234567-abcd-dcba-ffff-000000000000Phone number.
stringPhone number.
stringPhone number.
stringPhone number.
stringPhone number.
stringRelation to single entity instance.
01234567-abcd-dcba-ffff-000000000000Simple text input field.
stringSimple text input field.
stringSimple text input field.
stringSimple text input field.
stringRelation to single entity instance.
01234567-abcd-dcba-ffff-000000000000Simple text input field.
stringRevision when entity was lastly changed.
1Job position of Contact in his primary Account or quick account position if Contact has no primary Account.
stringIf account has any unsubscribed email.
falseInteger enum value: 0 - Unknown, 1 - Male, 2 - Female, 3 - NonBinary
00, 1, 2, 3Integer enum value: 0 - Standard, 1 - Private, 2 - AllView, 3 - AllEdit
00, 1, 2, 3Relation to CloudObject, see: 'createCloudObjectInput' object for properties.
Relation to ContactSocialRelation, see: 'createContactSocialRelationInput' object for properties.
Relation to ContactAccountRelation, see: 'createContactAccountRelationInput' object for properties.
Relation to ContactSharingSalesUnitRelation, see: 'createContactSharingSalesUnitRelationInput' object for properties.
Relation to ContactSharingClientRelation, see: 'createContactSharingClientRelationInput' object for properties.
Relation to CloudObjectRelation, see: 'createCloudObjectRelationInput' object for properties.
