Sign in
Super Admin Trials

Update a trial

Update a trial for an organization. Can update maxMessages and/or messagesSent. Only accessible to users with the super admin system role.

put/super-admin/trials/{orgId}

Request

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

Path parameters

orgIdstring required

The organization ID of the trial to update.

Request body

maxMessagesnumber

Maximum number of messages allowed in the trial

messagesSentnumber

Number of messages already sent (can be used to reset or adjust)

Example request

{
  "maxMessages": 2000
}

Response

Successfully updated 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.