1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Households
  4. Sales Account Resources

Update a sales team member

patch

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Request

Path Parameters
  • The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
  • The unique identifier of the member of the sales accounts resource team.
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Assignment Type
    Maximum Length: 30
    Default Value: MANUAL
    The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the sales team member. 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.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the address. A list of valid values is 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.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the sales team member of the household object. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Archived Date
    The date when the resource is dissociated from the sales account.
  • Title: Locked
    Maximum Length: 1
    Default Value: false
    Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
  • Title: Function
    Maximum Length: 30
    The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Title: Owner
    Default Value: false
    Indicates whether the resource is the owner.
  • The unique identifier of the associated party record for sales team member record.
  • The public identifier of the associated party record.
  • The name of external source system of the associated party record.
  • The unique identifier from external source system of the associated party record.
  • Title: Resource Email
    The email address of the resource.
  • Title: Resource Party Number
    The alternate key identifier of the resource that this team member belongs to.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Start Date
    The date on which the resource is associated with a sales account.
  • Title: Sales Account Resource ID
    The unique identifier of the member of the sales accounts resource team.
  • Title: User Last Update Date
    The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-SalesTeamMember-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
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 : households-SalesTeamMember-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : households-SalesTeamMember-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : households-SalesTeamMember-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : households-SalesTeamMember-item-response
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • Title: Assignment Type
    Maximum Length: 30
    Default Value: MANUAL
    The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the sales team member. 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the address. A list of valid values is 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.
  • Title: Currency Code
    Maximum Length: 15
    The currency code associated with the sales team member of the household object. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Archived Date
    The date when the resource is dissociated from the sales account.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the record.
  • Links
  • Title: Locked
    Maximum Length: 1
    Default Value: false
    Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. When a sales account team member is added manually, this flag is defaulted to `Y'.
  • Title: Function
    Maximum Length: 30
    The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
  • Title: Owner
    Default Value: false
    Indicates whether the resource is the owner.
  • The unique identifier of the associated party record for sales team member record.
  • The public identifier of the associated party record.
  • The name of external source system of the associated party record.
  • The unique identifier from external source system of the associated party record.
  • Title: Resource Email
    The email address of the resource.
  • Title: Resource ID
    The unique identifier of the household resource.
  • Title: Resource Name
    Read Only: true
    The name of the sales team member.
  • Read Only: true
    The name of the organization that the sales team member belongs to.
  • Title: Resource Party Number
    The alternate key identifier of the resource that this team member belongs to.
  • Title: Phone
    Read Only: true
    The primary phone number of the sales team member.
  • Title: Role
    Read Only: true
    The names of the roles assigned to the sales team member.
  • Title: Sales Account ID
    The unique identifier for the sales account.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Start Date
    The date on which the resource is associated with a sales account.
  • Title: Sales Account Resource ID
    The unique identifier of the member of the sales accounts resource team.
  • Title: User Last Update Date
    The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-SalesTeamMember-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
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 : households-SalesTeamMember-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : households-SalesTeamMember-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : households-SalesTeamMember-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
AccessLevelLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DZCA_ACCESS_LEVEL%2CLookupCode%3D{AccessLevelCode}
The list of values for the access level that determine the type of access granted, such as Edit or Full.

The following properties are defined on the LOV link relation:
  • Source Attribute: AccessLevelCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
MemberFunctionLOV
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION
The list of values indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager.

The following properties are defined on the LOV link relation:
  • Source Attribute: MemberFunctionCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
RatedCurrencies
The list of values for the corporate currency code, such as US Dollar or Indian Rupee.

The following properties are defined on the LOV link relation:
  • Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
  • Display Attribute: CurrencyCode
smartActions
Parameters:
  • PartyNumber: $request.path.PartyNumber
  • TeamMemberId: $request.path.TeamMemberId
This VO stores the endpoint and security details for every user action.
Back to Top

Examples

cURL Command

The following example shows how to update a sales team member by submitting a patch request on the REST resource using cURL. 

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_61285/child/SalesTeamMember/100100019286509

Example of Request Body

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

{
    "AccessLevelCode": "400",
    "LockAssignmentFlag": "false",
    "AssignmentTypeCode": "MANUAL",
    "ResourceEmailAddress": "Tenng.lean@oracle.com"
}

Example of Response Body

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

{
    "TeamMemberId": 100100019286509,
    "SalesProfileId": 100100018128609,
    "ResourceId": 100010025532138,
    "AccessLevelCode": "400",
    "LockAssignmentFlag": true,
    "AssignmentTypeCode": "MANUAL",
    "CreationDate": "2014-04-07T02:08:43-07:00",
    "CreatedBy": "DATA_STEWARD_MGR",
    "LastUpdateDate": "2014-04-07T02:08:43-07:00",
    "LastUpdatedBy": "DATA_STEWARD_MGR",
    "StartDateActive": "2014-04-07",
    "ResourcePartyNumber": "100010025532138",
    "ResourceEmailAddress": Tenng.lean@oracle.com
    ...
}
Back to Top