Skip to content
vocapable.Docs

Preview a people CSV (dry run: nothing changes until you apply it)

POST
/v1/workspace/people/imports
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/people/imports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "csv": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
Any of:
string

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspacePeopleImportCreate

A people CSV: email,name,role,team,skills,status (only email required).

object
csv
required
Csv
string
>= 1 characters <= 1000000 characters
Examplegenerated
{
  "csv": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspacePeopleImport
object
id
required
Id
string
status
required
Status
string
Allowed values: previewed applied expired
file_sha256
required
File Sha256
string
row_count
required
Row Count
integer
summary
required
Summary
object
key
additional properties
integer
rows
required
Rows
Array<object>
WorkspacePeopleImportRow
object
row_number
required
Row Number
integer
email
required
Email
string
full_name
required
Any of:
string
role
required
Any of:
string
team
required
Any of:
string
skills
required
Skills
object
key
additional properties
integer
action
required
Action
string
Allowed values: invite update deactivate unchanged error
error
required
Any of:
string
membership_id
required
Any of:
string
invitation_id
required
Any of:
string
teams
Teams
Array<string>
queues
Queues
Array<string>
created_at
required
Created At
string format: date-time
applied_at
required
Any of:
string format: date-time
Example
{
  "status": "previewed",
  "rows": [
    {
      "action": "invite"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}