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: string
  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: string
  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: string
  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(required): 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.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "required":[
        "LeadId"
    ],
    "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
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-item-post-request"
            }
        },
        "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
        }
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-item-post-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-item-post-request"
    }
}

Nested Schema : leads-MklLeadTcMembers1-smartActions-item-post-request

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel(required): string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Indicates whether the action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether the smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. It is used by the applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-post-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-post-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-post-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. It is used by the applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-post-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-post-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-post-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-post-request"
    }
}

Nested Schema : leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-post-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique system assigned identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false
        }
    }
}

Nested Schema : leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-post-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true
        }
    }
}

Nested Schema : leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-post-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        }
    }
}

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.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• 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
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-item-response"
            }
        },
        "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 : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-item-response"
    }
}

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."
        }
    }
}

Nested Schema : leads-MklLeadTcMembers1-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Indicates whether the action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether the smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. It is used by the applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionURLBinding: array Smart Action REST Path Parameter Definitions
  Title: Smart Action REST Path Parameter Definitions

  The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. It is used by the applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : leads-MklLeadTcMembers1-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique system assigned identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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 : leads-MklLeadTcMembers1-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : leads-MklLeadTcMembers1-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

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"
    }
}

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.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklLeadTcMembers1/{LeadMemberId}/child/smartActions

Parameters:

• LeadMemberId: $request.path.LeadMemberId
• leadsUniqID: $request.path.leadsUniqID

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

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