POST/desk/api/v2/users.json

Create a new user.

Body Params

UserAPIBody handles request/response for a single user

    • Name
      included
      Type
      object
      Description
      Included allows adding referenced objects on the API response. The included keys should map to the `types` in the Relationship slices/objects.
    • Name
      user
      Type
      object
      Description
      User is an agent within Teamwork Desk

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      UserAPIBody handles request/response for a single user
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    UserAPIBody
    {  "included": {    "inboxes": [      {        "autoReplyEnabled": true,        "autoReplyFromUserId": 0,        "autoReplyMessage": "string",        "autoReplySubject": "string",        "clientOnly": true,        "createdAt": "2025-10-03T18:19:07.592Z",        "createdBy": {          "delete": true,          "id": 0,          "meta": {            "additionalProp": "Unknown Type: any"          },          "type": 0        },
    Download Swagger