Jump to

• Request
• Response

Create a campaign resource

post

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignTeam

Request

Path Parameters

• CampaignNumber(required): string
  The alternate key identifier of the campaign.

Header Parameters

• Metadata-Context: string
  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: string
  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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Campaign Team Member Access Level Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"300",
            "x-queryable":false
        },
        "ApproverFlag":{
            "title":"Is Approver",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the team member is approver of the campaign.",
            "nullable":true,
            "default":false
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign resource belongs to.",
            "nullable":false
        },
        "CampaignTeamId":{
            "title":"Campaign Team Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CampaignTeamNumber":{
            "title":"Campaign Team Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign resource.",
            "nullable":false
        },
        "MemberFunctionCode":{
            "title":"Campaign Team Member Function Code",
            "maxLength":30,
            "type":"string",
            "description":"The role of lead contact in the context of this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether this resource is a primary resource for this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "ResourceId":{
            "title":"Campaign Team Member Party ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            }
        }
    }
}

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 : campaigns-CampaignTeam-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Campaign Team Member Access Level Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of a team member.",
            "nullable":false,
            "default":"300",
            "x-queryable":false
        },
        "ApproverFlag":{
            "title":"Is Approver",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the team member is approver of the campaign.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the campaign to which the campaign resource belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignTeamId":{
            "title":"Campaign Team Member ID",
            "type":"integer",
            "description":"The unique identifier of the campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignTeamNumber":{
            "title":"Campaign Team Member Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the campaign resource.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the campaign resource was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address associated with the campaign team resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The formatted phone number of the campaign resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"The date when the campaign resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MemberFunctionCode":{
            "title":"Campaign Team Member Function Code",
            "maxLength":30,
            "type":"string",
            "description":"The role of lead contact in the context of this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether this resource is a primary resource for this campaign.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "ResourceId":{
            "title":"Campaign Team Member Party ID",
            "type":"integer",
            "description":"The unique identifier associated with this sales campaign resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier associated with this campaign resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role of the campaign resource associated with the sales lead.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

AccessLevelCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

MemberFunctionCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Back to Top