Describe Program Member

GET /rest/v1/programs/members/describe.json

Returns metadata about program member objects in the target instance, including a list of all fields available for interaction via the APIs.

Operation ID: describeProgramMemberUsingGET2
Permissions: Read-Only Lead, Read-Write Lead
Request format: application/json
Returns: ResponseOfProgramMemberAttributes2

Responses

200 OK ResponseOfProgramMemberAttributes2

errors array of Error required

Array of errors that occurred if the request was unsuccessful

Model Error

code string required

Error code of the error. See full list of error codes here

message string required

Message describing the cause of the error

moreResult boolean

Boolean indicating if there are more results in subsequent pages

nextPageToken string

Paging token given if the result set exceeded the allowed batch size

requestId string required

Id of the request made

result array of ProgramMemberAttribute2 required

Array of results for individual records in the operation, may be empty

Model ProgramMemberAttribute2

name string required

"API Program Member"

description string required

"API Program Member Map"

createdAt string required

Datetime when created

updatedAt string required

Datetime updated

dedupeFields array of string required

List of dedupe fields

searchableFields array of LeadAttribute2SearchableFields required

List of searchable fields

fields array of LeadAttribute2Fields2 required

Description of searchable fields

Model LeadAttribute2Fields2

name string required

REST API name of field

displayName string required

Display name of field (friendly name)

dataType string required

Data type of field

length integer

Length of field

updateable boolean required

Is field updateable

crmManaged boolean required

Is field managed by CRM

success boolean required

Whether the request succeeded

warnings array of Warning required

Array of warnings given for the operation

Model Warning

code integer (int32) required

Integer code of the warning

message string required

Message describing the warning

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "name": "Example name",
      "description": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "dedupeFields": [
        "string"
      ],
      "searchableFields": [
        [
          "string"
        ]
      ],
      "fields": [
        {
          "name": "Example name",
          "displayName": "Example name",
          "dataType": "string",
          "length": 123,
          "updateable": true,
          "crmManaged": true
        }
      ]
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Generated from swagger-mapi.json. Generated examples are inferred from the schema; they are illustrative and may not be valid production payloads.