Jump to

• Request
• Response
• Examples

Create a sales lead contact

post

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1

Request

Path Parameters

• leadsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ConflictId: integer
  Title: Conflict Identifier

  Default Value: 0

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• ContactJobTitle: string
  Title: Job Title

  The label displaying the job title of a contact in his company.
• EmailAddress: string
  Title: Email

  The e-mail address associated with the sales lead contact.
• FormattedPhoneNumber: string
  Title: Phone

  The formatted phone number of the lead contact.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the sales lead for this sales lead contact.
• LeadMemberId: integer (int64)
  Title: Lead Contact ID

  The unique identifier for the sales lead contact.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The alternate unique identifier of the lead.
• PartyId: integer (int64)
  Title: Contact Party ID

  The unique identifier of the lead to which the contact is associated.
• PartyUsageCode: string
  Title: Party Usage Code

  Maximum Length: 30

  The party usage recorded for this lead contact in the customer master.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.
• RelationshipId: integer (int64)
  Title: Relationship ID

  The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.
• Role: string
  Title: Function

  Maximum Length: 30

  The role of lead contact in the context of this lead.

{
    "type":"object",
    "properties":{
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.",
            "nullable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address associated with the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS",
                    "ISBLANK"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":"0"
        },
        "Role":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role of lead contact in the context of this lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            }
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The label displaying the job title of a contact in his company.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "PartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the lead to which the contact is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            }
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LeadMemberId":{
            "title":"Lead Contact ID",
            "type":"integer",
            "description":"The unique identifier for the sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party usage recorded for this lead contact in the customer master.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : leads-MklLeadTcMembers1-item-response

Type: object

Show Source

• AccountName: string
  Title: Existing Account

  Read Only: true

  Maximum Length: 900

  The account name associated with lead contacts.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  City associated with the identifying address associated with this lead contact.
• ConflictId: integer
  Title: Conflict Identifier

  Default Value: 0

  The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.
• ContactDoNotCallFlag: boolean
  Title: Do Not Call

  Read Only: true

  Maximum Length: 1

  Indicates if the user can call the person. If the value is True, then the user can not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.
• ContactDoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates if the user can contact the person by phone, e-mail, or mail. If the value is True, then the user can not contact the person. The default value is False.
• ContactDoNotMailFlag: boolean
  Title: Do Not Mail

  Read Only: true

  Maximum Length: 1

  Indicates whether the sales lead person can be contacted.
• ContactJobTitle: string
  Title: Job Title

  The label displaying the job title of a contact in his company.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created this sales lead contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when this sales lead contact is created.
• EmailAddress: string
  Title: Email

  The e-mail address associated with the sales lead contact.
• EmailPreference: string
  Title: Email Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the lead contact has an email preference of do not email, ok to email, or no value.
• FormattedPhoneNumber: string
  Title: Phone

  The formatted phone number of the lead contact.
• JobTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The job title of the sales lead contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time of the last update of the sales lead contact.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the sales lead contact.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the sales lead record.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the sales lead for this sales lead contact.
• LeadMemberId: integer (int64)
  Title: Lead Contact ID

  The unique identifier for the sales lead contact.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  The alternate unique identifier of the lead.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgContactId: integer (int64)
  Title: Organization Contact ID

  Read Only: true

  The unique identifier of the Organization for this sales lead contact.
• PartyId: integer (int64)
  Title: Contact Party ID

  The unique identifier of the lead to which the contact is associated.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the lead contact.
• PartyNumber: string
  Title: Contact Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the sales lead contact.
• PartyType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  The type of the party recorded as lead contact. Possible values are person, organization or group.
• PartyUsageCode: string
  Title: Party Usage Code

  Maximum Length: 30

  The party usage recorded for this lead contact in the customer master.
• PersonFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  The first name of the lead contact.
• PersonLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  The last name or surname of a lead contact.
• PersonTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 60

  The title associated with the lead contact. This is not the same as the job title.
• PhonePreference: string
  Title: Phone Preference

  Read Only: true

  Maximum Length: 255

  Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  Postal code part of the identifying address associated with this lead contact.
• PrimaryCustomerId: integer (int64)
  Read Only: true

  The account party identifier of the account associated to the lead contact.
• PrimaryFlag: boolean
  Title: Primary

  Maximum Length: 1

  Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.
• RelationshipId: integer (int64)
  Title: Relationship ID

  The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.
• Role: string
  Title: Function

  Maximum Length: 30

  The role of lead contact in the context of this lead.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  State part of the identifying address associated with this lead contact.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when this sales lead contact is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "title":"Primary",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a lead contact is the primary contact. The primary lead contact is also the lead owner.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"Postal code part of the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the sales lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict Identifier",
            "type":"integer",
            "description":"The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title associated with the lead contact. This is not the same as the job title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhonePreference":{
            "title":"Phone Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether the lead contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "OrgContactId":{
            "title":"Organization Contact ID",
            "type":"integer",
            "description":"The unique identifier of the Organization for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The label displaying the job title of a contact in his company.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactDoNotCallFlag":{
            "title":"Do Not Call",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can call the person. If the value is True, then the user can not call the person. The default value is False. \nA list of accepted values is defined using the lookup YES_NO. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the sales lead for this sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LeadMemberId":{
            "title":"Lead Contact ID",
            "type":"integer",
            "description":"The unique identifier for the sales lead contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            },
            "x-queryable":true
        },
        "ContactDoNotMailFlag":{
            "title":"Do Not Mail",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sales lead person can be contacted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the party recorded as lead contact. Possible values are person, organization or group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created this sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name or surname of a lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "EmailPreference":{
            "title":"Email Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the lead contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId1"
                ]
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the lead.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"City associated with the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            },
            "x-queryable":true
        },
        "ContactDoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can contact the person by phone, e-mail, or mail. If the value is True, then the user can not contact the person. The default value is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address associated with the sales lead contact.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS",
                    "ISBLANK"
                ],
                "Dependencies":"PartyId1",
                "dependencies":[
                    "PartyId1"
                ]
            },
            "x-queryable":true
        },
        "Role":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The role of lead contact in the context of this lead.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Contact Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The party number of the sales lead contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Contact Party ID",
            "type":"integer",
            "description":"The unique identifier of the lead to which the contact is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique relationship identifier for this lead contact. This represents the relation of this lead contact with lead customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"State part of the identifying address associated with this lead contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            },
            "x-queryable":true
        },
        "PartyUsageCode":{
            "title":"Party Usage Code",
            "maxLength":"30",
            "type":"string",
            "description":"The party usage recorded for this lead contact in the customer master.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of the last update of the sales lead contact.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the sales lead record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Existing Account",
            "maxLength":"900",
            "type":"string",
            "description":"The account name associated with lead contacts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryCustomerId":{
            "type":"integer",
            "description":"The account party identifier of the account associated to the lead contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

HzLookupPVO1

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Back to Top

Examples

cURL Command

The following example shows how to create a contact by submitting a POST request on the REST resource using cURL.

curl -u <username:password> \ -X POST -d @example_request_payload.json -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/

Example of Request Body

The following shows an example of the request body in JSON format..

{"PartyId":300100090715456}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "LeadMemberId" : 300100092582198,
  "RelationshipId" : null,
  "PartyUsageCode" : null,
  "PartyId" : 300100090715456,
  "Role" : null,
  "CreatedBy" : "MHoope",
  "CreationDate" : "2016-11-07T04:17:00-08:00",
  "LastUpdatedBy" : "MHoope",
  "LastUpdateDate" : "2016-11-07T04:17:00-08:00",
  "LeadId" : 300100092582093,
  "PartyName" : "Test Contact",
  "PrimaryFlag" : false,
  "PersonLastName" : "Contact",
  "PersonFirstName" : "Test",
  "PartyType" : "PERSON",
  "PersonTitle" : null,
  "FormattedPhoneNumber" : "[phone] x22",
  "PartyNumber" : "CDRM_568258",
  "EmailAddress" : "[e-mail]",
  "OrgContactId" : null,
  "JobTitle" : null,
  "ContactDoNotCallFlag" : false,
  "ContactDoNotContactFlag" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582198",
    "name" : "MklLeadTcMembers1",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000005737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582198",
    "name" : "MklLeadTcMembers1",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/300100092582093",
    "name" : "leads",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklLeadTcMembers1/300100092582198/lov/HzLookupPVO1",
    "name" : "HzLookupPVO1",
    "kind" : "Collection"
  } ]
}

Back to Top