Skip to content
Dream Center Connect LogoDream Center Connect

Create a new volunteer bulk import session

POST
/api/volunteers/import/session
curl --request POST \
  --url https://example.com/api/volunteers/import/session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "partner_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "reconcile_exceptions": false }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
organization_id
string format: uuid
partner_id
required
string format: uuid
reconcile_exceptions
boolean

Responses

Section titled “Responses”

201

Section titled “201”

Import session created successfully

Media typeapplication/json
object
session_id
required
string format: uuid
id
string format: uuid
organization_id
required
string format: uuid
partner_id
required
string format: uuid
reconcile_exceptions
boolean
status
required
string
expires_at
required
string format: date-time
Example
{
  "reconcile_exceptions": false,
  "status": "active"
}

400

Section titled “400”

Bad request / Invalid input parameters

Media typeapplication/problem+json

RFC 7807 Problem Details for HTTP APIs

object
type
required
string
title
required
string
status
required

Current status of the record or process.

integer
detail
required
string
instance
string
retry_after
integer
Example
{
  "status": "IN_PROGRESS",
  "retry_after": 60
}

401

Section titled “401”

Authentication required or invalid credentials

Media typeapplication/problem+json

RFC 7807 Problem Details for HTTP APIs

object
type
required
string
title
required
string
status
required

Current status of the record or process.

integer
detail
required
string
instance
string
retry_after
integer
Example
{
  "status": "IN_PROGRESS",
  "retry_after": 60
}

403

Section titled “403”

Access denied / Insufficient role privileges

Media typeapplication/problem+json

RFC 7807 Problem Details for HTTP APIs

object
type
required
string
title
required
string
status
required

Current status of the record or process.

integer
detail
required
string
instance
string
retry_after
integer
Example
{
  "status": "IN_PROGRESS",
  "retry_after": 60
}