afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/CampaignMemberStatus.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "usage",
    "associated_objects",
    "wsdl_segment",
    "field_reference"
  ],
  "title": "CampaignMemberStatus - Data API",
  "description": "One or more member status values defined for a campaign.",
  "fields_columns": [
    "type",
    "properties",
    "description"
  ],
  "fields": {
    "CampaignId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "ID of the campaign associated with this member status."
    },
    "HasResponded": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether this status is equivalent to “Responded” (true) or not (false). Beginning with API version 39.0, at least one CampaignMemberStatus on each campaign must have a hasResponded value of true."
    },
    "IsDefault": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter, Group, Sort",
      "description": "Indicates whether this status is the default status (true) or not (false). Beginning with API version 39.0, there must be a default CampaignMemberStatus defined for every campaign."
    },
    "IsDeleted": {
      "type": "boolean",
      "properties": "Defaulted on create, Filter",
      "description": "Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted."
    },
    "Label": {
      "type": "string",
      "properties": "Filter, Sort",
      "description": "Label for the status in the picklist. Limited to 765 characters."
    },
    "SortOrder": {
      "type": "int",
      "properties": "Filter, Group, Sort, Update",
      "description": "Unique number order where this campaign member status appears in the picklist."
    }
  },
  "special_access_rules": "Customer Portal users can't access this object. You can't delete a CampaignMemberStatus if that status is designated as the default status or if the status is currently used in a Campaign.\n\nCustomer Portal users can't access this object.\n\nYou can't delete a CampaignMemberStatus if that status is designated as the default status or if the status is currently used in a Campaign.",
  "usage": "Use this object to create picklist items for the member status in a campaign. This object is defined only for those organizations that have the marketing feature and valid marketing licenses. In addition, the object is accessible only to those users that are enabled as marketing users. If the organization does not have the marketing feature or valid marketing licenses, this object does not appear in a describeGlobal() call, and you can't use describeSObjects() or query() with the CampaignMember object.\n\nUse this object to create picklist items for the member status in a campaign.\n\nThis object is defined only for those organizations that have the marketing feature and valid marketing licenses. In addition, the object is accessible only to those users that are enabled as marketing users. If the organization does not have the marketing feature or valid marketing licenses, this object does not appear in a describeGlobal() call, and you can't use describeSObjects() or query() with the CampaignMember object.",
  "associated_objects": "This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.\n\n- **CampaignMemberStatusChangeEvent (API version 46.0)**: Change events are available for the object.",
  "wsdl_segment": "```xml\n<complexType name=\"CampaignMemberStatus\">\n  <complexContent>\n    <extension base=\"ens:sObject\">\n      <sequence>\n        <element name=\"CampaignId\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"HasResponded\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDefault\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <element name=\"Label\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n        <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n        <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n        <element name=\"SortOrder\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n        <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n      </sequence>\n    </extension>\n  </complexContent>\n</complexType>\n<simpleType name=\"ID\">\n  <restriction base=\"xsd:string\">\n    <length value=\"18\"/>\n    <pattern value=\"[a-zA-Z0-9]{18}\"/>\n  </restriction>\n</simpleType>\n```",
  "field_reference": {
    "CampaignId": {
      "field_label": "Campaign ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "HasResponded": {
      "field_label": "Responded",
      "type": "boolean"
    },
    "Id": {
      "field_label": "Campaign Member Status ID",
      "type": "id",
      "length": "18"
    },
    "IsDefault": {
      "field_label": "Is Default",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "Label": {
      "field_label": "Member Status",
      "type": "string",
      "length": "765"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "SortOrder": {
      "field_label": "Sort Order",
      "type": "int",
      "digits": "9"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "length",
    "digits"
  ]
}