Jump to

• Request
• Response
• Examples

Update an opportunity contact

patch

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityContact/{OptyConId}

Request

Path Parameters

• OptyConId(required): integer(int64)
  The unique identifier of the contact associated with the opportunity.
• OptyNumber(required): string
  The unique alternate identifier for the opportunity.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AffinityLvlCd: string
  Title: Affinity Level

  Maximum Length: 30

  The code indicating the affinity of the opportunity 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.
• Comments: string
  Title: Comments

  Maximum Length: 255

  The textual comments about the contact on the current opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContactedFlg: string
  Title: Contacted

  Maximum Length: 1

  Default Value: N

  Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
• ContactPointId: integer
  The unique identifier of the contact point for an opportunity contact.
• InfluenceLvlCd: string
  Title: Influence Level

  Maximum Length: 30

  The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• LastUpdateLogin: string
  Maximum Length: 32

  The session login associated to the user who last updated the record.
• OptyId: integer (int64)
  Title: Opportunity

  The unique identifier of the opportunity.
• PERPartyId: integer (int64)
  Title: Opportunity Contact

  The party identifier of the opportunity contact.
• PrimaryFlg: string
  Title: Primary

  Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.
• RelationshipId: integer (int64)
  The identifier of the relationship for the opportunity contact.
• RoleCd: string
  Title: Function

  Maximum Length: 30

  The code identifying the roles played by a contact in the opportunity. 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.

{
    "type":"object",
    "properties":{
        "ContactedFlg":{
            "title":"Contacted",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The textual comments about the contact on the current opportunity.",
            "nullable":true
        },
        "InfluenceLvlCd":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleCd":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifying the roles played by a contact in the opportunity. 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,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "OptyId":{
            "title":"Opportunity",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The identifier of the relationship for the opportunity contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the contact point for an opportunity contact.",
            "nullable":true,
            "x-queryable":false
        },
        "AffinityLvlCd":{
            "title":"Affinity Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of the opportunity 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,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "x-queryable":false
        },
        "PERPartyId":{
            "title":"Opportunity Contact",
            "type":"integer",
            "description":"The party identifier of the opportunity contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            }
        }
    }
}

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 : opportunities-OpportunityContact-item-response

Type: object

Show Source

• AffinityLvlCd: string
  Title: Affinity Level

  Maximum Length: 30

  The code indicating the affinity of the opportunity 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.
• Comments: string
  Title: Comments

  Maximum Length: 255

  The textual comments about the contact on the current opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• ContactedFlg: string
  Title: Contacted

  Maximum Length: 1

  Default Value: N

  Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.
• ContactPartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the opportunity contact party.
• ContactPointId: integer
  The unique identifier of the contact point for an opportunity contact.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the opportunity contact record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the contact record was created.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.
• EmailAddress: string
  Title: Email

  Read Only: true

  The e-mail address of the contact.
• EmailPreference: string
  Title: Email Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the opportunity contact has an email preference of do not email, ok to email, or no value.
• FormattedAddress: string
  Title: Address

  Read Only: true

  Maximum Length: 255

  The formatted address of the contact.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the contact.
• InfluenceLvlCd: string
  Title: Influence Level

  Maximum Length: 30

  The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.
• JobTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 100

  The free form text for job title of the opportunity contact.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyConId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the opportunity.
• OptyId: integer (int64)
  Title: Opportunity

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OrganizationPartyId: integer (int64)
  Read Only: true

  The unique identifier of the contact's organization.
• OrganizationPartyName: string
  Title: Organization

  Read Only: true

  Maximum Length: 360

  The name of the contact's organization.
• OrgContactId: integer (int64)
  Read Only: true

  The unique identifier of the organization contact for the opportunity.
• PartyName: string
  Title: Opportunity Contact Name

  Read Only: true

  Maximum Length: 360

  The name of the contact for the opportunity.
• PartyUniqueName: string
  Title: Related Account

  Read Only: true

  Maximum Length: 900

  The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.
• PERPartyId: integer (int64)
  Title: Opportunity Contact

  The party identifier of the opportunity contact.
• PersonCentricJobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the contact person.
• PhonePreference: string
  Title: Phone Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the opportunity contact has a phone preference of do not call, ok to call, or no value.
• PreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.
• PrimaryFlg: string
  Title: Primary

  Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.
• RelationshipCode: string
  Title: Relationship Code

  Read Only: true

  Maximum Length: 30

  The code indicating whether it's a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.
• RelationshipId: integer (int64)
  The identifier of the relationship for the opportunity contact.
• RoleCd: string
  Title: Function

  Maximum Length: 30

  The code identifying the roles played by a contact in the opportunity. 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.
• SalesAffinityCode: string
  Title: Affinity

  Read Only: true

  Maximum Length: 30

  The code indicating the affinity of the opportunity 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.
• SalesBuyingRoleCode: string
  Title: Buying Role

  Read Only: true

  Maximum Length: 30

  The code identifying the roles played by a contact in the buying process. 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.
• SalesInfluenceLevelCode: string
  Title: Influence Level

  Read Only: true

  Maximum Length: 30

  The code indicating the influence the opportunity contact has on the buying process of the current opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the contact record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactedFlg":{
            "title":"Contacted",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the contact for this opportunity has been contacted. If the value is True, then the contact was contacted. The default value is False.",
            "nullable":true,
            "default":"N",
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OptyConId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationPartyId":{
            "type":"integer",
            "description":"The unique identifier of the contact's organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyUniqueName":{
            "title":"Related Account",
            "maxLength":"900",
            "type":"string",
            "description":"The unique contact name displayed on party related screens. The default value for Contacts is the concatenation of attributes ContactName and UniqueNameSuffix. The default value for Organizations is the concatenation of the unique name alias and UniqueNameSuffix.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Opportunity Contact Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact for the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "dependencies":[
                    "PERPartyId",
                    "RelationshipId"
                ]
            },
            "x-queryable":true
        },
        "PrimaryFlg":{
            "title":"Primary",
            "type":"string",
            "description":"Indicates if the contact is the primary contact for the opportunity. If the value is True, then the contact is the primary contact of the opportunity. The default value is False.",
            "nullable":true,
            "x-queryable":false
        },
        "JobTitle":{
            "title":"Title",
            "maxLength":"100",
            "type":"string",
            "description":"The free form text for job title of the opportunity contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationPartyName":{
            "title":"Organization",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the contact's organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PhonePreference":{
            "title":"Phone Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the opportunity contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "OrgContactId":{
            "type":"integer",
            "description":"The unique identifier of the organization contact for the opportunity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RelationshipCode":{
            "title":"Relationship Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating whether it's a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPointId":{
            "type":"integer",
            "description":"The unique identifier of the contact point for an opportunity contact.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SalesInfluenceLevelCode":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the influence the opportunity contact has on the buying process of the current opportunity. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. 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,
            "x-hints":{
                "dependencies":[
                    "RelationshipId"
                ]
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "PreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":"30",
            "type":"string",
            "description":"The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "PERPartyId":{
            "title":"Opportunity Contact",
            "type":"integer",
            "description":"The party identifier of the opportunity contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity contact record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"255",
            "type":"string",
            "description":"The textual comments about the contact on the current opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "InfluenceLvlCd":{
            "title":"Influence Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the influence the opportunity contact has on the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_INFLUENCE_LVL_CD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Address",
            "maxLength":"255",
            "type":"string",
            "description":"The formatted address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailPreference":{
            "title":"Email Preference",
            "maxLength":"255",
            "type":"string",
            "description":"Indicates if the opportunity contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "PersonCentricJobTitle":{
            "title":"Job Title",
            "maxLength":"100",
            "type":"string",
            "description":"The job title of the contact person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleCd":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifying the roles played by a contact in the opportunity. 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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesBuyingRoleCode":{
            "title":"Buying Role",
            "maxLength":"30",
            "type":"string",
            "description":"The code identifying the roles played by a contact in the buying process. 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-hints":{
                "dependencies":[
                    "RelationshipId"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "OptyId":{
            "title":"Opportunity",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ContactPartyNumber":{
            "title":"Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the opportunity contact party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default is False.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"The identifier of the relationship for the opportunity contact.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AffinityLvlCd":{
            "title":"Affinity Level",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of the opportunity 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,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesAffinityCode":{
            "title":"Affinity",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the affinity of the opportunity 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-hints":{
                "dependencies":[
                    "RelationshipId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : 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."
        }
    }
}

Links

OptyContactYesNoLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeFinder%3BBindLookupType%3DYES_NO

The lookups resource is used to view standard lookup codes.

PreferredContactMethodLookupPVO

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_PREFERRED_CONTACT_METHOD%2CBindLookupCode%3D{PreferredContactMethod}

The lookups resource is used to view standard lookup codes.

ZbsBuyingRoleTypesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE%2CBindLookupCode%3D{RoleCd}

The lookups resource is used to view standard lookup codes.

ZbsContactAffinityTypesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE%2CBindLookupCode%3D{AffinityLvlCd}

The lookups resource is used to view standard lookup codes.

ZbsInfluenceLevelTypesLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DHZ_SLS_CNTCT_INFLUENCE_LVL_CD%2CBindLookupCode%3D{InfluenceLvlCd}

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

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

cURL Command

curl -u <username:password> \ -X -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_341580//child/OpportunityContact/300100092629555

Example of Request Body

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

{
"RoleCd": "SECONDARY_DECISION_MAKER"
}

Example of Response Body

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

 {
OptyConId: 300100092629555,
CreatedBy: "MHoope",
ContactedFlg: "N",
CreationDate: "2016-11-17T05:54:14-08:00",
OptyId: 300100092516122,
PERPartyId: 100000016934214,
PrimaryFlg: "N",
PartyName: "Matt Baird",
OptyConId: 300100092629899,
EmailAddress: "[e-mail]",
ContactPointId: 300100026717170,
FormattedAddress: "South Avenue,MANHATTAN, NY 10005",
FormattedPhoneNumber: "[phone] x6567",
DoNotContactFlag: false,
ContactPartyNumber: 100000016934213,
RoleCd: "SECONDARY_DECISION_MAKER",
...
}

Back to Top