Skip to content
Dream Center Connect LogoDream Center Connect

Record volunteer check-in or check-out punch

POST
/api/integrations/clock/punch
curl --request POST \
  --url https://example.com/api/integrations/clock/punch \
  --header 'Content-Type: application/json' \
  --header 'x-kiosk-secret: <x-kiosk-secret>' \
  --data '{ "phone": "+17045551234", "action": "auto" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
phone
required
string
Example
+17045551234
action
string
default: auto
Allowed values: auto in out
Example
auto

Responses

Section titled “Responses”

200

Section titled “200”

Punch recorded successfully

Media typeapplication/json
object
status
required
string
Allowed values: clocked_in clocked_out
volunteer_name
required
string
clock_in
required
string format: date-time
clock_out
string format: date-time
nullable
Example
{
  "status": "clocked_in",
  "volunteer_name": "Jane D."
}

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
}

404

Section titled “404”

Resource not found

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
}

409

Section titled “409”

Resource state conflict

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
}