PropperDocs

Create a support team

.md

Add a group of agents tickets can be given to.

Scopesadmin:write
Permissionmanage_support_settings
POST/v1/admin/support-teams

A new support team: a name, and the agents on it. The agents to pick from are the agents of the ticket options.

The members are checked as a whole. One that is not among the firm's agents refuses the save, rather than being dropped from the team without anyone noticing.

Needs a firm. Our own staff name one with the Propper-Workspace header.

Request

FieldDescription
nameUp to 100 characters, unique within the firm. Required
member_idsThe id of every agent on the team, up to 200. Required, and may be empty
curl -X POST "https://api.proppertrading.com/v1/admin/support-teams" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme" \
  -H "Idempotency-Key: 6c8e0a2b-4d6f-4a8c-9e0b-2d4f6a8c0e2b" \
  -H "Content-Type: application/json" \
  -d '{"name": "Platform desk", "member_ids": ["usr_afekquw8p97wv6tb", "usr_58rb28huxg3h5vv3"]}'

Response

201, with the team:

{
    "data": {
        "object": "support_team",
        "id": "team_xmwh3fde7wym7xkj",
        "name": "Platform desk",
        "members": [
            {
                "id": "usr_afekquw8p97wv6tb",
                "name": "Sam Carter"
            },
            {
                "id": "usr_58rb28huxg3h5vv3",
                "name": "Waldo Hansen"
            }
        ],
        "open": 0,
        "mine": false
    },
    "meta": {
        "request_id": "req_01m50v19nncp16d8kn6xwejqe6"
    }
}

Errors

StatusCodeMeaning
400workspace_requiredAsked by our own staff without naming a firm
400missing_idempotency_keyA POST without an Idempotency-Key header
401invalid_tokenNot a token, or the secret does not match
401revoked_tokenSigned out here or from another device
401expired_tokenNinety days without use, or a set expiry passed
403admin_access_requiredThis account no longer helps run the environment
403insufficient_scopeThis device does not hold admin:write
403workspace_not_permittedThe Propper-Workspace header names an environment this account cannot act in
403forbiddenWithout manage_support_settings
422validation_failedNo name, a name the firm already has, no member_ids, more than 200, or a member who is not one of the firm's agents