Super Admin Trials

Create a new trial

Create a new trial for an organization. Only accessible to users with the super admin system role.

post/super-admin/trials

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

orgIdstring uuid required

Organization ID for which to create the trial

maxMessagesnumber required

Maximum number of messages allowed in the trial

Example request

{
  "orgId": "123e4567-e89b-12d3-a456-426614174000",
  "maxMessages": 1000
}

Response

Successfully created trial for the super admin.

idstring uuid required

Trial unique identifier

orgIdstring uuid required

Organization ID associated with this trial

messagesSentnumber required

Number of messages sent in this trial

maxMessagesnumber required

Maximum number of messages allowed in this trial

createdAtstring date-time required

Date when the trial was created

updatedAtstring date-time required

Date when the trial was last updated

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "orgId": "123e4567-e89b-12d3-a456-426614174000",
  "messagesSent": 150,
  "maxMessages": 1000,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 51 revisions of this API.