POST v1/contacts

Creates or updates a contact.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
FirstName	string	Required
LastName	string	None.
Phones	Collection of Phone	None.
Emails	Collection of EmailAddress	None.
Address	Address	None.
CustomFields	Collection of CustomField	None.

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "phones": [
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    },
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    }
  ],
  "emails": [
    {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    },
    {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    }
  ],
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "address3": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "postalCode": "sample string 6",
    "country": "sample string 7",
    "latitude": 8.0,
    "longitude": 9.0,
    "fullAddress": "sample string 10"
  },
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ]
}

application/xml, text/xml

Sample:

<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.CRM">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:Address3>sample string 3</d2p1:Address3>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Country>sample string 7</d2p1:Country>
    <d2p1:FullAddress>sample string 10</d2p1:FullAddress>
    <d2p1:Latitude>8</d2p1:Latitude>
    <d2p1:Longitude>9</d2p1:Longitude>
    <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
    <d2p1:State>sample string 5</d2p1:State>
  </Address>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <Emails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:EmailAddress>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
    </d2p1:EmailAddress>
    <d2p1:EmailAddress>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
    </d2p1:EmailAddress>
  </Emails>
  <FirstName>sample string 2</FirstName>
  <Id>1</Id>
  <LastName>sample string 3</LastName>
  <Phones xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
  </Phones>
</Contact>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Contact

Name	Type	Additional information
Id	integer	None.
FirstName	string	Required
LastName	string	None.
Phones	Collection of Phone	None.
Emails	Collection of EmailAddress	None.
Address	Address	None.
CustomFields	Collection of CustomField	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "firstName": "sample string 2",
  "lastName": "sample string 3",
  "phones": [
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    },
    {
      "id": 1,
      "phoneType": {
        "id": 1,
        "name": "sample string 2"
      },
      "countryDialCode": 2,
      "number": "sample string 3",
      "extension": "sample string 4",
      "isPreferred": true,
      "active": true
    }
  ],
  "emails": [
    {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    },
    {
      "id": 1,
      "email": "sample string 2",
      "isPrimary": true,
      "active": true
    }
  ],
  "address": {
    "address1": "sample string 1",
    "address2": "sample string 2",
    "address3": "sample string 3",
    "city": "sample string 4",
    "state": "sample string 5",
    "postalCode": "sample string 6",
    "country": "sample string 7",
    "latitude": 8.0,
    "longitude": 9.0,
    "fullAddress": "sample string 10"
  },
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ]
}

application/xml, text/xml

Sample:

<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.CRM">
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Address1>sample string 1</d2p1:Address1>
    <d2p1:Address2>sample string 2</d2p1:Address2>
    <d2p1:Address3>sample string 3</d2p1:Address3>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Country>sample string 7</d2p1:Country>
    <d2p1:FullAddress>sample string 10</d2p1:FullAddress>
    <d2p1:Latitude>8</d2p1:Latitude>
    <d2p1:Longitude>9</d2p1:Longitude>
    <d2p1:PostalCode>sample string 6</d2p1:PostalCode>
    <d2p1:State>sample string 5</d2p1:State>
  </Address>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <Emails xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:EmailAddress>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
    </d2p1:EmailAddress>
    <d2p1:EmailAddress>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Email>sample string 2</d2p1:Email>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPrimary>true</d2p1:IsPrimary>
    </d2p1:EmailAddress>
  </Emails>
  <FirstName>sample string 2</FirstName>
  <Id>1</Id>
  <LastName>sample string 3</LastName>
  <Phones xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
    <d2p1:Phone>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:CountryDialCode>2</d2p1:CountryDialCode>
      <d2p1:Extension>sample string 4</d2p1:Extension>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsPreferred>true</d2p1:IsPreferred>
      <d2p1:Number>sample string 3</d2p1:Number>
      <d2p1:PhoneType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:PhoneType>
    </d2p1:Phone>
  </Phones>
</Contact>