Create a portal recipient — never creates a user, never touches billable seats

POST

/api/v1/workspaces/{ws}/portal-recipients

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

label

required

string

>= 1 characters <= 200 characters

email

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

linked_record_id

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

expires_at

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

Example^generated

{
  "label": "example",
  "email": "hello@example.com",
  "linked_record_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "expires_at": "2026-04-15T12:00:00Z"
}

Responses

201