pbs-library

POST `/v1/pbs-library/teams/{teamId}/invites`

Create a single-use invite code for a team member or client site.

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/pbs-library/teams/{teamId}/invites \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The code is returned once and stored only as a SHA-256 hash.

Parameters

Name	Type	Required	What it is
`teamId (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`role`	`string<read, write>`	No	—
`days`	`integer`	No	—
`label`	`string`	No	—

Response

Name	Type	Required	What it is
`code`	`string`	Yes	`zpi_…`, shown once.
`role`	`string<read, write>`	Yes	—
`expires_at`	`string`	Yes	—

Errors this endpoint can return

401 · 403 · 404 · 409 · 429

POST /v1/pbs-library/teams/{teamId}/invites