Change a trial's buddy
PUT
/api/staff-trials/{accountId}/buddyNeeds Manage users. Sign-offs already given stay as they are.
AuthorizationBearer <token>
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Path Parameters
accountId*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PUT "https://example.com/api/staff-trials/497f6eca-6276-4993-bfeb-53cbbbba6f08/buddy" \ -H "Content-Type: application/json" \ -d '{ "buddyId": "439ab535-2456-425e-a0d5-d66aad0e447f" }'{ "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "username": "string", "buddyId": "439ab535-2456-425e-a0d5-d66aad0e447f", "buddyName": "string", "startedAt": "2019-08-24T14:15:22Z", "buddyNote": null, "buddyNoteAt": null, "closedAt": null, "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "text": "string", "answer": null, "answeredAt": null, "signedOffAt": null, "signedOffBy": null } ], "canAnswer": true, "canSignOff": true, "canManage": true}Start a trial POST
Give an account a checklist and a buddy. The lines are copied from Settings now. Needs Manage users, and the account must be below your highest role and not your own.
Close a trial POST
The trial stops counting as running and gets no more reminders. The checklist, answers and sign-offs stay. Needs Manage users, and the account must be below your highest role.