Import Program Members

POST /bulk/v1/program/{programId}/members/import.json

Imports a file containing data records into the target instance.

Operation ID: importProgramMemberUsingPOST
Permissions: Read-Write Lead
Request format: multipart/form-data
Returns: ResponseOfImportProgramMemberResponse

Parameters

Path 1

programId string required

Id of the program to add members to.

Query 2

programMemberStatus string required

Program member status for members being added.

format string required

Import file format.

Values CSV TSV SSV

Form 1

file file required

File containing the data records to import.

Responses

200 OK ResponseOfImportProgramMemberResponse

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

requestId string required

Id of the request made

result array of ImportProgramMemberResponse required

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

Model ImportProgramMemberResponse

batchId integer (int32) required

Unique integer id of the import job

importId string required

Unique integer id of the import job

status string required

Status of the import job

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"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "batchId": 123,
      "importId": "123",
      "status": "string"
    }
  ],
  "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.