Update a sales team member

patch

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

Request

Path Parameters
  • The alternate key identifier for the contact 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 sales team member.
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. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • 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 sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency Code
    Maximum Length: 15
    The 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 value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Archived Date
    Date on which this sales team member is no longer active.
  • 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. The default value is False. 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 locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • Title: Owner
    Default Value: false
    Indicates whether the contact is the owner of the contract.
  • The unique identifier of the party.
  • The unique identification number for the party.
  • The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
  • The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
  • Title: Resource Email
    The e-mail address of the resource.
  • Title: Resource Party Number
    The alternate key identifier of the resource that this team member belongs to.
  • Title: Start Date
    Date on which this sales team member becomes active.
  • Title: Sales Account Resource ID
    The unique identifier of the sales team member.
  • 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.
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 : contacts-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. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task.
  • 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 sales team member record.
  • Title: Creation Date
    Read Only: true
    The date and time when the sale team member record was created.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Currency Code
    Maximum Length: 15
    The 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 value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
  • Title: Archived Date
    Date on which this sales team member is no longer active.
  • Title: Last Updated Date
    Read Only: true
    The date when the sales team member record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the sales team member record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the sales team member 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. The default value is False. 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 locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
  • Title: Owner
    Default Value: false
    Indicates whether the contact is the owner of the contract.
  • The unique identifier of the party.
  • The unique identification number for the party.
  • The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
  • The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
  • Title: Resource Email
    The e-mail 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 of the sales profile of the resource.
  • Title: Start Date
    Date on which this sales team member becomes active.
  • Title: Sales Account Resource ID
    The unique identifier of the sales team member.
  • 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.
Back to Top

Examples

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

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CDRM_2515/child/SalesTeamMember/300100018233318

Example of Request Body

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

{
    "AccessLevelCode": "300",
    "LockAssignmentFlag": "true",
    "AssignmentTypeCode": "TERRITORY_BASED",
    "ResourceEmailAddress": "tenng.lean@oracle.com"
}

Example of Response Body

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

{
    "TeamMemberId": 300100018233318,
    "SalesProfileId": 300100018233310,
    "ResourceId": 100010025532672,
    "MemberFunctionCode": null,
    "AccessLevelCode": "300",
    "LockAssignmentFlag": true,
    "AssignmentTypeCode": "TERRITORY_BASED",
    "ResourcePartyNumber": "100010025532672",
    "ResourceEmailAddress": "tenng.lean@oracle.com ",
    ...
}
Back to Top