Create Participant.

POST /api/teams/{team}/participants

Path parameters

  • team integer Required

    The ID of the team that the participants belong to.

application/json

Body Required

  • key string Required

    The key to use for the participant. Must match the regex /[a-z0-9]+(?:_[a-z0-9]+)*$/i. Must not be greater than 255 characters.

  • notes string

    Notes about the participant.

Responses

POST /api/teams/{team}/participants
curl \
 -X POST https://checkmango.com/api/teams/19/participants \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"key":"jbrooksuk","notes":"mollitia"}'
Request example
{
  "key": "jbrooksuk",
  "notes": "mollitia"
}
Response examples (200)
{
  "data": {
    "id": "ODIO_ADIPISCI_TEMPORIBUS_IPSUM_ID",
    "type": "participants",
    "attributes": {
      "id": 3,
      "team_id": 50,
      "key": "ODIO_ADIPISCI_TEMPORIBUS_IPSUM_ID",
      "notes": null,
      "created": {
        "human": "1 second ago",
        "string": "2024-04-08 10:42:02"
      },
      "updated": {
        "human": "1 second ago",
        "string": "2024-04-08 10:42:02"
      }
    },
    "links": {
      "self": {
        "href": "http://checkmango.com/api/teams/50/participants/ODIO_ADIPISCI_TEMPORIBUS_IPSUM_ID"
      }
    }
  }
}
Response examples (201)
{
  "data": {
    "id": "jbrooksuk",
    "type": "participant",
    "attributes": {
      "id": 1,
      "team_id": 4,
      "key": "jbrooksuk",
      "experiment_count": 0,
      "created": {
        "human": "6 minutes ago",
        "string": "2021-11-02 21:43:28"
      },
      "updated": {
        "human": "6 minutes ago",
        "string": "2021-11-02 21:43:28"
      }
    },
    "relationships": [],
    "links": {
      "self": "https://prove.dev/api/teams/1/participants/jbrooksuk"
    }
  }
}
Response examples (402)
{
  "message": "Subscription required."
}
Response examples (403)
{
  "message": "Unauthenticated."
}
Response examples (404)
{
  "message": "Not Found"
}
Response examples (422)
{
  "message": "The given data was invalid.",
  "errors": {
    "key": [
      "The key has already been taken."
    ]
  }
}