POST collaboration/contacts

Creates a new contact

Note: Log in to check if your API client have access to run this resource
Version: 6
Success HTTP Status Code: 201

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
<Contact>
2
     <FirstName
FirstName

Firstname/givenname of the contact

This field is optional.

>
{String}</FirstName>
3
     <LastName
LastName

Required/mandatory field

Surname/familyname/lastname of the contact

>
{String}</LastName>
4
     <JobTitle
JobTitle

Professional title

This field is optional.

>
{String}</JobTitle>
5
     <PreferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Applicable domain values can be found here when logged in

This field is optional.

>
{String}</PreferredLanguage>
6
</Contact>
1
{
2
     "contact": {
3
          "firstName
FirstName

Firstname/givenname of the contact

This field is optional.

":
"{String}",
4
          "lastName
LastName

Required/mandatory field

Surname/familyname/lastname of the contact

":
"{String}",
5
          "jobTitle
JobTitle

Professional title

This field is optional.

":
"{String}",
6
          "preferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Applicable domain values can be found here when logged in

This field is optional.

":
"{String}"
7
     }
8
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Contact>
2
     <ContactId
ContactId

Contact identifier

>
{Integer}</ContactId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
4
     <Status
Status

Status of the contact. 1:New, 4:Active, 9:Inactive

Possible domain values can be found here when logged in

>
{Integer}</Status>
5
     <FirstName
FirstName

Firstname/givenname of the contact

>
{String}</FirstName>
6
     <LastName
LastName

Surname/familyname/lastname of the contact

>
{String}</LastName>
7
     <JobTitle
JobTitle

Professional title

>
{String}</JobTitle>
8
     <ExternalPrivileges
ExternalPrivileges

Privileges to external applications for contact

Possible domain values can be found here when logged in

>
{String}</ExternalPrivileges>
9
     <PreferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Possible domain values can be found here when logged in

>
{String}</PreferredLanguage>
10
     <Category
Category

Category of the contact

Possible domain values can be found here when logged in

>
{String}</Category>
11
     <Source
Source

Source of which the personal information was obtained

Possible domain values can be found here when logged in

>
12
          <EmailId
EmailId

Email identifier

>
{Integer}</EmailId>
13
          <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
14
          <Type
Type

Type of email

Possible domain values can be found here when logged in

>
{String}</Type>
15
          <Address
Address

The email address

>
{String}</Address>
16
          <EmailLink
EmailLink

Email reference

>
{String}</EmailLink>
17
          <PhoneId
PhoneId

Phone identifier

>
{Integer}</PhoneId>
18
          <PhoneNumber
PhoneNumber

The phone number

>
{String}</PhoneNumber>
19
          <Type
Type

Type of phone

Possible domain values can be found here when logged in

>
{String}</Type>
20
          <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
21
          <PhoneLink
PhoneLink

Phone reference

>
{String}</PhoneLink>
22
     </Source>
23
     <Privacy>
24
          <HasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

>
{Boolean}</HasAcceptedPrivacyPolicy>
25
          <HasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

>
{Boolean}</HasMarketingConsent>
26
          <LegalBasisForDataProcessing
LegalBasisForDataProcessing

The legal basis for processing contact's data

Possible domain values can be found here when logged in

>
{Integer}</LegalBasisForDataProcessing>
27
     </Privacy>
28
</Contact>
1
{
2
     "contact": {
3
          "contactId
ContactId

Contact identifier

":
"{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
5
          "status
Status

Status of the contact. 1:New, 4:Active, 9:Inactive

Possible domain values can be found here when logged in

":
"{Integer}",
6
          "firstName
FirstName

Firstname/givenname of the contact

":
"{String}",
7
          "lastName
LastName

Surname/familyname/lastname of the contact

":
"{String}",
8
          "jobTitle
JobTitle

Professional title

":
"{String}",
9
          "externalPrivileges
ExternalPrivileges

Privileges to external applications for contact

Possible domain values can be found here when logged in

":
"{String}",
10
          "preferredLanguage
PreferredLanguage

Three character code following the ISO 639-2 standard.

Possible domain values can be found here when logged in

":
"{String}",
11
          "category
Category

Category of the contact

Possible domain values can be found here when logged in

":
"{String}",
12
          "source
Source

Source of which the personal information was obtained

Possible domain values can be found here when logged in

":
{
13
               "emailId
EmailId

Email identifier

":
"{Integer}",
14
               "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
15
               "type
Type

Type of email

Possible domain values can be found here when logged in

":
"{String}",
16
               "address
Address

The email address

":
"{String}",
17
               "emailLink
EmailLink

Email reference

":
"{String}",
18
               "phoneId
PhoneId

Phone identifier

":
"{Integer}",
19
               "phoneNumber
PhoneNumber

The phone number

":
"{String}",
20
               "type
Type

Type of phone

Possible domain values can be found here when logged in

":
"{String}",
21
               "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
22
               "phoneLink
PhoneLink

Phone reference

":
"{String}"
23
          },
24
          "privacy": {
25
               "hasAcceptedPrivacyPolicy
HasAcceptedPrivacyPolicy

Privacy policy accepted. Yes or no value.

":
"{Boolean}",
26
               "hasMarketingConsent
HasMarketingConsent

Consent to marketing. Yes or no value.

":
"{Boolean}",
27
               "legalBasisForDataProcessing
LegalBasisForDataProcessing

The legal basis for processing contact's data

Possible domain values can be found here when logged in

":
"{Integer}"
28
          }
29
     }
30
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100036 HTTP 400 Missing required input parameter: {0}
Error 100006 HTTP 400 Invalid document identifier: {0}
Error 102529 HTTP 404 RamBase event type not found
Error 100009 HTTP 400 Missing required input arguments
Error 100012 HTTP 400 {0} must exist in {1}
Error 100034 HTTP 404 Contact not found
Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 100044 HTTP 400 Current owner {0} still uses this contact for document handling
Error 100010 HTTP 400 {0} must be unique
Error 100045 HTTP 400 Can not delete reference {0} because it still uses this contact
Error 100264 HTTP 400 Both contact identifier and identifier that the contact should be linked to are required
Error 101420 HTTP 404 Setting definition not found
Error 100031 HTTP 404 Customer not found
Error 100047 HTTP 404 Supplier not found
Error 100048 HTTP 400 Parameter {0}: {1} not valid
Error 101015 HTTP 404 Permission not found
Error 101514 HTTP 400 Setting definition reference is required
Error 101708 HTTP 400 Default value is required
Error 101640 HTTP 400 Data type is required
Error 100051 HTTP 400 When logged in as supplier {0} you do not have access to this API resource
Error 100055 HTTP 403 You have only admittance to your own objects
Error 101119 HTTP 404 Shipping Service document not found
Error 101304 HTTP 404 Carrier not found
Error 102738 HTTP 404 Price list not found
Error 100050 HTTP 403 No admittance as customer {0}
Error 100053 HTTP 403 You have only admittance to your own suppliers