Update a campaign resource
patch
/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam/{CampaignTeamId}
Request
Path Parameters
-
CampaignNumber(required): string
The alternate key identifier of the campaign.
-
CampaignTeamId(required): integer(int64)
The unique identifier of the campaign resource.
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
Root Schema : schema
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Campaign Team Member Access Level Code
Maximum Length:30
Default Value:300
The code indicating the access level of a team member. -
ApproverFlag: boolean
Title:
Is Approver
Maximum Length:1
Default Value:false
Indicates whether the team member is approver of the campaign. -
MemberFunctionCode: string
Title:
Campaign Team Member Function Code
Maximum Length:30
The role of lead contact in the context of this campaign. -
OwnerFlag: boolean
Title:
Owner
Indicates whether this resource is a primary resource for this campaign.
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 : campaigns-CampaignTeam-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Campaign Team Member Access Level Code
Maximum Length:30
Default Value:300
The code indicating the access level of a team member. -
ApproverFlag: boolean
Title:
Is Approver
Maximum Length:1
Default Value:false
Indicates whether the team member is approver of the campaign. -
CampaignId: integer
(int64)
Title:
Campaign ID
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign resource belongs to. -
CampaignTeamId: integer
(int64)
Title:
Campaign Team Member ID
The unique identifier of the campaign resource. -
CampaignTeamNumber: string
Title:
Campaign Team Member Number
Maximum Length:30
The alternate key identifier of the campaign resource. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign resource. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign resource was created. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address associated with the campaign team resource. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The formatted phone number of the campaign resource. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign resource was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberFunctionCode: string
Title:
Campaign Team Member Function Code
Maximum Length:30
The role of lead contact in the context of this campaign. -
OwnerFlag: boolean
Title:
Owner
Indicates whether this resource is a primary resource for this campaign. -
ResourceId: integer
(int64)
Title:
Campaign Team Member Party ID
The unique identifier associated with this sales campaign resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the party associated with the campaign resource. -
ResourcePartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The alternate key identifier associated with this campaign resource. -
RoleName: string
Title:
Role Name
Read Only:true
Maximum Length:60
The name of the role of the campaign resource associated with the sales lead.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- AccessLevelCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_ACCESS_LEVEL
The following properties are defined on the LOV link relation:- Source Attribute: AccessLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberFunctionCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_TEAM_ROLE
The following properties are defined on the LOV link relation:- Source Attribute: MemberFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: