Contacts: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Contacts resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Contact
Child Resources	Address
	Contact Address > Contact Address Purpose
	Primary Address
	Relationship
	SalesTeamMember
	Note
	Attachment
	Aux Classification
	Contact Attachments

The following table lists the attributes required for the POST method for Contacts resource.

Resource	Attribute	Attribute Description
Contact	First name	The first name of the person.
	Last name	The last name of the person. Note: You can create a contact using the first name or the last name, but it is recommended you use both.

The following table lists the attributes required for the POST method for Contacts child resources.

Resource	Attribute	Attribute Description
Contact > Address For contacts, the address is required based on the profile option code ZCA_CONTACT_ADDRESS_REQUIRED_ENABLED. If the profile option is set as, NO: Address is not required. YES: Address is required for all contact types (such as ZCA_PROSPECT, ZCA_CONTACT and ZCA_CUSTOMER). Required for Customer: Address is necessary for the account type ZCA_CUSTOMER, in which case Address1 and Country is required, while Address2 is optional.	Address1	The first line for address.
	Address2	The second line for the address.
	Country	The country code of the address. The list of values for countries is available in the CountryLOV.
Contact > Contact Address > Contact Address Purpose	Purpose	The use or purpose of the address.
Contact > Primary Address	AddressLine1	The first line for the primary address.
	AddressLine2	The second line for the primary address.
	Country	The country code of the primary address. The list of values for countries is available in the CountryLOV.
Contact > Relationship	SubjectPartyNumber	The primary key identifier of the subject in this relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
	RelationshipType	The type of relationship of a contact party, such as CUSTOMER_SUPPLIER. A list of accepted relationship type values is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups task. The list of values for relationship types is available in the RelationshipTypeLookupLOV.
	RelationshipCode	The code for a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups. The list of values of relationship codes is available in the RelationshipCodeLookupLOV.
Contact > Sales Team Member	AccessLevelCode	The type of access granted to the resource as well as managers of the organizations. A list of accepted values is defined in the lookup ZCA_ACCESS_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. The list of values of access level codes is available in the AccessLevelLOV.
	LockAssignmentFlag	Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to Y.
	AssignmentTypeCode	The code indicating how the resource is assigned to the sales account team. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. A list of accepted values is available in the lookup ZCA_ASSIGNMENT_TYPE.
	ResourceEmailAddress	The e-mail address of the resource.
Contact > Note	NoteTxt	The actual note text.
	NoteTypeCode	The code for categorization of the note type. The list of values of note codes is available in the NoteSourceTypeVA.
	VisibilityCode	The visibility level of the note. The list of values of note visibility codes is available in the NoteVisibilityLookupVA.
Contact > Attachments	DatatypeCode	The data type for the picture attachment.
	FileName	The name of the attachment file.
	FileContents	The contents of the attachment.

The following table lists the path parameters required for the PATCH method for Contacts resource.

Resource	Path	Path Parameters
Contact	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}	PartyNumber

The following table lists the path parameters required for the PATCH method for Contacts child resources.

Resource	Path	Path Parameters
Contact > Address	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Address/{AddressNumber}	PartyNumber AddressNumber
Contact > Contact Address > Contact Address Purpose	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}	PartyNumber AddressNumber AddressPurposeId
Contact > Primary Address	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}	PartyNumber AddressNumber
Contact > Relationship	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}	PartyNumber RelationshipRecId
Contact > Sales Team Member	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/SalesTeamMember/{SalesTeamMemberId}	PartyNumber SalesTeamMemberId
Contact > Note	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Note/{NoteId}	PartyNumber NoteId
Contact > Attachments	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}	PartyNumber PictureAttachmentUniqID
Contacts > Aux Classification	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}	PartyNumber CodeAssignmentId
Contacts > Contact Attachments	/crmRestApi/resources/11.13.18.10/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}	PartyNumber AttachmentUniqID