Jump to

• Request
• Response
• Examples

Update an activity contact

patch

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact/{ActivityContactUniqID}

Request

Path Parameters

• ActivityContactUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ActivityId and ContactId ---for the Activity Contacts resource and used to uniquely identify an instance of Activity Contacts. The client should not generate the hash key value. Instead, the client should query on the Activity Contacts collection resource with a filter on the primary key values in order to navigate to a specific instance of Activity Contacts.
  
  For example: ActivityContact?q=ActivityId=<value1>;ContactId=<value2>
• ActivityNumber(required): string
  The unique number of the activity. The number can also be generated from an external source.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountId: integer
  The unique identifier of the account.
• AttendeeFlag: boolean
  Title: Attendance

  Maximum Length: 1

  Default Value: true

  Indicates if the contact attended the activity. If True, the contact attended.
• ConflictId: integer (int64)
  Default Value: 0

  This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
• ContactAccount: string
  Title: Account

  The account associated with the activity contact.
• ContactAccountId: integer
  The unique identifier of the account associated with the activity contact.
• ContactAccountType: string
  The account type for the contact.
• ContactCustomer: string
  Title: Contact Customer

  The customer contact for the activity.
• ContactEmail: string
  Title: Email

  The e-mail address of the activity contact.
• ContactJobTitle: string
  Title: Title

  The job title of the activity contact.
• ContactLovSwitcher: string
  Indicates contact LOV switcher (Not for public usage).
• ContactName: string
  Title: Name

  The name of the contact for the activity.
• ContactPhone: string
  Title: Phone

  The phone number of the activity contact.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency used by the activity contact.
• CurcyConvRateType: string
  Maximum Length: 30

  The rate of currency conversion for an activity contact.
• CurrencyCode: string
  Maximum Length: 15

  The currency used for an activity contact.
• EmailContactPreferenceFlag: string
  Indicates the email contact preference.
• ExternalContactEmail: string
  Title: External Contact Email

  Maximum Length: 320

  The email address of the external contact.
• ExternalContactFlag: boolean
  Title: External Contact

  Maximum Length: 1

  Default Value: false

  Flag indicating that an activity is owned by an external contact.
• ExternalContactName: string
  Title: External Contact Name

  Maximum Length: 360

  The name of an external contact.
• PhoneContactPreferenceFlag: string
  Indicates the phone contact preference.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates if this contact is the primary contact.
• PrimaryFormattedAddress: string
  The formatted address information of the activity contact.
• RelationshipId: integer (int64)
  Title: Relationship ID

  The unique identifier of the relationship of the contact.
• 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.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date and time of when the contact was last updated by a user in the disconnect mode.

{
    "type":"object",
    "properties":{
        "AccountId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "nullable":true
        },
        "AttendeeFlag":{
            "title":"Attendance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the contact attended the activity. If True, the contact attended.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ConflictId":{
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "ContactAccount":{
            "title":"Account",
            "type":"string",
            "description":"The account associated with the activity contact.",
            "nullable":true
        },
        "ContactAccountId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the activity contact.",
            "nullable":true
        },
        "ContactAccountType":{
            "type":"string",
            "description":"The account type for the contact.",
            "nullable":true
        },
        "ContactCustomer":{
            "title":"Contact Customer",
            "type":"string",
            "description":"The customer contact for the activity.",
            "nullable":true
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the activity contact.",
            "nullable":true
        },
        "ContactJobTitle":{
            "title":"Title",
            "type":"string",
            "description":"The job title of the activity contact.",
            "nullable":true
        },
        "ContactLovSwitcher":{
            "type":"string",
            "description":"Indicates contact LOV switcher (Not for public usage).",
            "nullable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the contact for the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ContactPhone":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the activity contact.",
            "nullable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency used by the activity contact.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The rate of currency conversion for an activity contact.",
            "nullable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency used for an activity contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmailContactPreferenceFlag":{
            "type":"string",
            "description":"Indicates the email contact preference.",
            "nullable":true
        },
        "ExternalContactEmail":{
            "title":"External Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the external contact.",
            "nullable":true
        },
        "ExternalContactFlag":{
            "title":"External Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating that an activity is owned by an external contact.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ExternalContactName":{
            "title":"External Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of an external contact.",
            "nullable":true
        },
        "PhoneContactPreferenceFlag":{
            "type":"string",
            "description":"Indicates the phone contact preference.",
            "nullable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if this contact is the primary contact.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFormattedAddress":{
            "type":"string",
            "description":"The formatted address information of the activity contact.",
            "nullable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time of when the contact was last updated by a user in the disconnect mode.",
            "format":"date-time",
            "nullable":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/activities-ActivityContact-smartActions-item-patch-request"
            }
        }
    }
}

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 activities-ActivityContact-smartActions-item-patch-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/activities-ActivityContact-smartActions-item-patch-request"
    }
}

Nested Schema : activities-ActivityContact-smartActions-item-patch-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: 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

  Boolean type indicating if this 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

  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. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• 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.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type 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
        },
        "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
        },
        "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
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "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
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true
        },
        "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. Used by 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
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/activities-ActivityContact-smartActions-UserActionNavigation-item-patch-request"
            }
        },
        "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
            }
        },
        "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/activities-ActivityContact-smartActions-UserActionRequestPayload-item-patch-request"
            }
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/activities-ActivityContact-smartActions-UserActionURLBinding-item-patch-request"
            }
        }
    }
}

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 activities-ActivityContact-smartActions-UserActionNavigation-item-patch-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/activities-ActivityContact-smartActions-UserActionNavigation-item-patch-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 activities-ActivityContact-smartActions-UserActionRequestPayload-item-patch-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/activities-ActivityContact-smartActions-UserActionRequestPayload-item-patch-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 activities-ActivityContact-smartActions-UserActionURLBinding-item-patch-request

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

Nested Schema : activities-ActivityContact-smartActions-UserActionNavigation-item-patch-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Indicates 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.
• 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":"Indicates 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
        },
        "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
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":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
        }
    }
}

Nested Schema : activities-ActivityContact-smartActions-UserActionRequestPayload-item-patch-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.
• 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

  Indicates 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
        },
        "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
        },
        "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
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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
        },
        "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
        },
        "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
        }
    }
}

Nested Schema : activities-ActivityContact-smartActions-UserActionURLBinding-item-patch-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

  Indicates whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• 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
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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
        },
        "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
        }
    }
}

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 : activities-ActivityContact-item-response

Type: object

Show Source

• AccountId: integer
  The unique identifier of the account.
• ActivityContactId: integer (int64)
  Title: Activity Contact ID

  The unique identifier for the surrogate activity contact.
• ActivityContactKey: string
  Title: Activity Contact Key

  Read Only: true

  Maximum Length: 80

  Activity contact composite key
• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the parent activity for the objective.
• ActivityNumber: string
  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• ActyActivityNumber: string
  Title: Activity Number

  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• Affinity: string
  Read Only: true

  The affinity of an activity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• AttendeeFlag: boolean
  Title: Attendance

  Maximum Length: 1

  Default Value: true

  Indicates if the contact attended the activity. If True, the contact attended.
• BuyingRole: string
  Title: Buying Role

  Read Only: true

  The roles played by the activity contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• ConflictId: integer (int64)
  Default Value: 0

  This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.
• ContactAccount: string
  Title: Account

  The account associated with the activity contact.
• ContactAccountId: integer
  The unique identifier of the account associated with the activity contact.
• ContactAccountType: string
  The account type for the contact.
• ContactCustomer: string
  Title: Contact Customer

  The customer contact for the activity.
• ContactEmail: string
  Title: Email

  The e-mail address of the activity contact.
• ContactId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the activity.
• ContactJobTitle: string
  Title: Title

  The job title of the activity contact.
• ContactLovSwitcher: string
  Indicates contact LOV switcher (Not for public usage).
• ContactName: string
  Title: Name

  The name of the contact for the activity.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the activity contact.
• ContactPhone: string
  Title: Phone

  The phone number of the activity contact.
• CorpCurrencyCode: string
  Maximum Length: 15

  The corporate currency used by the activity contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the activity contact.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the activity contact was created.
• CurcyConvRateType: string
  Maximum Length: 30

  The rate of currency conversion for an activity contact.
• CurrencyCode: string
  Maximum Length: 15

  The currency used for an activity contact.
• DoNotCallFlag: boolean
  Read Only: true

  Indicates whether the contact should be called. The default value is false.
• DoNotContactFlag: boolean
  Read Only: true

  Indicates whether the activity contact should be contacted. The default value is false.
• DoNotEmailFlag: boolean
  Read Only: true

  Indicates whether the contact should be emailed. The default value is false.
• EmailContactPreferenceFlag: string
  Indicates the email contact preference.
• ExternalContactEmail: string
  Title: External Contact Email

  Maximum Length: 320

  The email address of the external contact.
• ExternalContactFlag: boolean
  Title: External Contact

  Maximum Length: 1

  Default Value: false

  Flag indicating that an activity is owned by an external contact.
• ExternalContactName: string
  Title: External Contact Name

  Maximum Length: 360

  The name of an external contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time of when the activity contact was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The unique identifier of the user who last updated the activity contact. This is defaulted by the system.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the activity objective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Read Only: true

  The activity contact name.
• PhoneContactPreferenceFlag: string
  Indicates the phone contact preference.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates if this contact is the primary contact.
• PrimaryFormattedAddress: string
  The formatted address information of the activity contact.
• RecurSeriesId: integer (int64)
  The unique identifier that links instances of a series together.
• RelationshipId: integer (int64)
  Title: Relationship ID

  The unique identifier of the relationship of the contact.
• 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.
• UpgSourceObjectId: integer (int64)
  Read Only: true

  The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
• UpgSourceObjectType: string
  Read Only: true

  Maximum Length: 30

  The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date and time of when the contact was last updated by a user in the disconnect mode.

{
    "type":"object",
    "properties":{
        "AccountId":{
            "type":"integer",
            "description":"The unique identifier of the account.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityContactId":{
            "title":"Activity Contact ID",
            "type":"integer",
            "description":"The unique identifier for the surrogate activity contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityContactKey":{
            "title":"Activity Contact Key",
            "maxLength":80,
            "type":"string",
            "description":"Activity contact composite key",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the parent activity for the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":true,
            "x-queryable":true
        },
        "ActyActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false,
            "x-queryable":true
        },
        "Affinity":{
            "type":"string",
            "description":"The affinity of an activity contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AttendeeFlag":{
            "title":"Attendance",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the contact attended the activity. If True, the contact attended.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "BuyingRole":{
            "title":"Buying Role",
            "type":"string",
            "description":"The roles played by the activity contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"This value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server). This attribute is obsolete.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactAccount":{
            "title":"Account",
            "type":"string",
            "description":"The account associated with the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAccountId":{
            "type":"integer",
            "description":"The unique identifier of the account associated with the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactAccountType":{
            "type":"string",
            "description":"The account type for the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactCustomer":{
            "title":"Contact Customer",
            "type":"string",
            "description":"The customer contact for the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactEmail":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactJobTitle":{
            "title":"Title",
            "type":"string",
            "description":"The job title of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLovSwitcher":{
            "type":"string",
            "description":"Indicates contact LOV switcher (Not for public usage).",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the contact for the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the activity contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPhone":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency used by the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the activity contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the activity contact was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The rate of currency conversion for an activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency used for an activity contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "type":"boolean",
            "description":"Indicates whether the contact should be called. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DoNotContactFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity contact should be contacted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DoNotEmailFlag":{
            "type":"boolean",
            "description":"Indicates whether the contact should be emailed. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailContactPreferenceFlag":{
            "type":"string",
            "description":"Indicates the email contact preference.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactEmail":{
            "title":"External Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactFlag":{
            "title":"External Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag indicating that an activity is owned by an external contact.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "ExternalContactName":{
            "title":"External Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time of when the activity contact was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the activity objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the user who last updated the activity contact. This is defaulted by the system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "type":"string",
            "description":"The activity contact name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneContactPreferenceFlag":{
            "type":"string",
            "description":"Indicates the phone contact preference.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if this contact is the primary contact.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryFormattedAddress":{
            "type":"string",
            "description":"The formatted address information of the activity contact.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "type":"integer",
            "description":"The unique identifier that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship of the contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpgSourceObjectId":{
            "type":"integer",
            "description":"The primary key value of the record in the source table that is upgraded to Rel9 Activity record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpgSourceObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time of when the contact was last updated by a user in the disconnect mode.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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/activities-ActivityContact-smartActions-item-response"
            }
        }
    }
}

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 activities-ActivityContact-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/activities-ActivityContact-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 : activities-ActivityContact-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

  Boolean type indicating if this 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

  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. Used by 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 identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The unique identifier of the 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 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 parameters 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":{
        "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
        },
        "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
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type 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
        },
        "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
        },
        "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
        },
        "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
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "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
        },
        "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
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"System assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "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. Used by 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
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique identifier of the smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view 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/activities-ActivityContact-smartActions-UserActionNavigation-item-response"
            }
        },
        "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
        },
        "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/activities-ActivityContact-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameters 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/activities-ActivityContact-smartActions-UserActionURLBinding-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 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 activities-ActivityContact-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view 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/activities-ActivityContact-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 activities-ActivityContact-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/activities-ActivityContact-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameters 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 activities-ActivityContact-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameters 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/activities-ActivityContact-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : activities-ActivityContact-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

  Indicates 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 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":"Indicates 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
        },
        "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
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique 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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : activities-ActivityContact-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

  Indicates 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
        },
        "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
        },
        "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
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : activities-ActivityContact-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

  Indicates 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 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
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

smartActions

Operation: /crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityContact/{ActivityContactUniqID}/child/smartActions

Parameters:

• ActivityContactUniqID: $request.path.ActivityContactUniqID
• ActivityNumber: $request.path.ActivityNumber

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

The following example shows how to update an activity contact by submitting a PATCH request on the REST resource using cURL.

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167275/child/ActivityContact/00020000000EACED00057708000110F07F5743280000000EACED00057708000110F07A57BA75

Example of Request Body

The following shows an example of the request body.

{"ActivityId":300100091331368,
  "ContactId":300100007475829,
  "AttendeeFlag":false} 

Example of Response Body

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

{
"ActivityId": 300100091331368
"ContactId": 300100007475829
"RelationshipId": null
"ActivityNumber": null
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-08-24T00:31:27-07:00"
"LastUpdateDate": "2016-08-24T02:29:47-07:00"
"LastUpdateLogin": "3ACD2BA10C14B0DEE053780CF10A305B"
"LastUpdatedBy": "SALES_ADMIN"
"ObjectVersionNumber": 4
"ConflictId": 0
"UserLastUpdateDate": null
"PrimaryContactFlag": true
"ContactName": "Mike Rabatin"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
"ContactEmail": null
"ContactPhone": "[phone]"
"ContactJobTitle": null
"EmailContactPreferenceFlag": null
"PhoneContactPreferenceFlag": null
"ContactCustomer": null
"ContactAccount": null
"AccountId": null
"ContactLovSwitcher": "LOV_ContactName"
"ActivityContactId": 300100091331387
"DoNotContactFlag": false
"DoNotCallFlag": false
"DoNotEmailFlag": false
"ContactAccountId": null
"ContactAccountType": null
"UpgSourceObjectId": null
"UpgSourceObjectType": null
"RecurSeriesId": null
"AttendeeFlag": false
"Affinity": ""
"BuyingRole": ""
"PrimaryFormattedAddress": null
"ContactPartyNumber": "CDRM_575"
-
}

Back to Top