Create or continue agent-led workplace signup

POST/v1/workplaces

Save a private bootstrap proof before the first request. The display name does not select the Mailbox address. Supply an optional exact mailboxAddressChoice before signup or receive an automatic permanent address. Issued addresses cannot be renamed. A matching unacknowledged retry replaces the previous key.

Request Body

application/json

name*string

Length:1 <= length <= 100

nominatedEmail*string

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

Format:email

Length:length <= 254

bootstrapProof*string

Match:^[A-Za-z0-9_-]{43}$

mailboxAddressChoice?|

expectedChoiceRevision?integer

Range:0 <= value <= 9007199254740991

Response Body

application/json

curl -X POST "https://example.com/v1/workplaces" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "nominatedEmail": "user@example.com",
    "bootstrapProof": "string"
  }'

{
  "mailbox": {
    "mailboxId": "f16f762c-c61b-441d-8b9c-9aff4650cbe1",
    "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
    "address": "user@example.com"
  },
  "workplaceId": "4989ce91-52f9-461b-87fa-af1f28004fc0",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "cleanupAt": "2019-08-24T14:15:22Z",
  "credential": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string"
  }
}

POST

Create or continue agent-led workplace signup

Request Body

Response Body

200