1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Subscriptions
  4. Parties

Update a subscription party

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/parties/{PartyPuid}

Request

Path Parameters
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
Nested Schema : Contacts
Type: array
Title: Contacts
The contacts resource to view, create, update, and delete the contacts in a subscription party.
Show Source
Nested Schema : Subscription User Actions
Type: array
Title: Subscription User Actions
The smart actions resource stores the endpoint and security details for every user action.
Show Source
Nested Schema : subscriptions-parties-contacts-item-patch-request
Type: object
Show Source
Nested Schema : subscriptions-parties-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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    The binding of the user action payload.
  • Title: Mandatory
    Maximum Length: 1
    The mandatory flag of the user action payload.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The request payload name of the user action.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The smart suggest path of the user action payload.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system action flag of the user action request payload.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value of the user action payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    The value structure of the user action payload.
Nested Schema : schema
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    The URL binding of user action.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    The system action flag of the user action URL binding.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    The name of URL binding of user action.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    The value of URL binding of user action.
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 : subscriptions-parties-item-response
Type: object
Show Source
Nested Schema : Contacts
Type: array
Title: Contacts
The contacts resource to view, create, update, and delete the contacts in a subscription party.
Show Source
Nested Schema : Subscription User Actions
Type: array
Title: Subscription User Actions
The smart actions resource stores the endpoint and security details for every user action.
Show Source
Nested Schema : subscriptions-parties-contacts-item-response
Type: object
Show Source
Nested Schema : subscriptions-parties-smartActions-item-response
Type: object
Show Source
Nested Schema : User Action Navigation
Type: array
Title: User Action Navigation
The user action navigation resource stores the UI navigation metadata striped by app usage.
Show Source
Nested Schema : User Action Request Payload
Type: array
Title: User Action Request Payload
The user action request payload resource stores the payload information for every user action request.
Show Source
Nested Schema : User Action URL Binding
Type: array
Title: User Action URL Binding
The user action URL binding resource stores the binding metadata for a variable in the URL.
Show Source
Nested Schema : subscriptions-parties-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : subscriptions-parties-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : subscriptions-parties-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
Links
PartyRoleLookupVA
The list of values indicating the party role.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartyRole; Target Attribute: LookupCode
  • Display Attribute: Meaning
PrimaryPartyVA
The list of values indicating the party name.

The following properties are defined on the LOV link relation:
  • Source Attribute: PartyName; Target Attribute: PartyName
  • Display Attribute: PartyName, PartyNumber
contacts
Parameters:
  • PartyPuid: $request.path.PartyPuid
  • SubscriptionNumber: $request.path.SubscriptionNumber
The contacts resource to view, create, update, and delete the contacts in a subscription party.
smartActions
Parameters:
  • PartyPuid: $request.path.PartyPuid
  • SubscriptionNumber: $request.path.SubscriptionNumber
The smart actions resource stores the endpoint and security details for every user action.
Back to Top

Examples

The following example shows how to update a subscription party by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptions/ANK-123/child/parties/GP-5678-PRTY-24

Example of Request Body

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

{     
   
"PrimaryFlag": false
}}

Example of Response Body

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

{
    "SubscriptionPartyId": 300100188555749,
    "PartyPuid": "GP-5678-PRTY-24",
    "SubscriptionId": 300100188539254,
    "PartyRole": "ORA_CUSTOMER",
    "PartyId": 300100070252912,
    "PrimaryFlag": false,
    "InternalFlag": false,
    "ObjectVersionNumber": 1,
    "CreatedBy": "CONMGR",
    "CreationDate": "2021-02-04T14:59:33+00:00",
    "LastUpdatedBy": "CONMGR",
    "LastUpdateDate": "2021-02-04T14:59:33.066+00:00",
    "LastUpdateLogin": "B9859B9A67B8AB62E0533BFDF40A5224",
    "PartyName": " Clarke James",
    "PartyNumber": "CDRM_154814",
...
}
Back to Top