Update an address
patch
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Request
Path Parameters
-
AddressNumber(required): string
The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update.
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
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
Root Schema : schema
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressType: string
Title:
Type
The lookup code for the type of address, such as billing address, shipping address etc. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code of the address associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country of the address. Review the list of countries using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
The module that created the address record. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the partner associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
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. -
SourceSystem: string
The identifier of the record from external source system.
-
SourceSystemReferenceValue: string
The name of the external source system.
-
State: string
Title:
State
Maximum Length:60
The state of the address. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
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
Nested Schema : partners-addresses-smartActions-item-patch-request
Type:
Show Source
object
-
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 for 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 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
-
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.
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
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
Nested Schema : partners-addresses-smartActions-UserActionRequestPayload-item-patch-request
Type:
Show Source
object
-
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
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.
Nested Schema : partners-addresses-smartActions-UserActionURLBinding-item-patch-request
Type:
Show Source
object
-
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. -
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.
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.
Root Schema : partners-addresses-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier of the address. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or Kana representation of the Kanji address lines. This is used for addresses in Japan. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. One of AddressId or AddressNumber keys is used to identify the address record during update. -
AddressType: string
Title:
Type
The lookup code for the type of address, such as billing address, shipping address etc. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address. -
City: string
Title:
City
Maximum Length:60
The city in the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used in North America to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user-provided comments for the address. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code of the address associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country of the address. Review the list of countries using the Manage Geographies task. -
CountryName: string
Read Only:
true
The name of the country of the partner company. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
The module that created the address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
The description of the location. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates whether the address should not be used for mailing. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the address. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiline version of the address. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
Latitude: number
Title:
Latitude
The latitude information for the address. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the address location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for the location. -
Longitude: number
Title:
Longitude
The longitude information for the address. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
PartyId: integer
(int64)
Title:
Party ID
The unique identifier of the partner associated with the address. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the partner. If the value is Y, then this address is the primary address of the partner. The default value is N. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
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. -
SourceSystem: string
The identifier of the record from external source system.
-
SourceSystemReferenceValue: string
The name of the external source system.
-
State: string
Title:
State
Maximum Length:60
The state of the address. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates whether the location is validated. The value is internally set by system during address cleansing. If the value is Y, then the address is validated. The default value is N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : partners-addresses-smartActions-item-response
Type:
Show Source
object
-
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 for 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 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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : partners-addresses-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-addresses-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The territories resource is used to get a list of ISO standard territories. - finder:
- smartActions
-
Parameters:
- AddressNumber:
$request.path.AddressNumber
- CompanyNumber:
$request.path.CompanyNumber
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. - AddressNumber: