Update Participant.

PUT /api/teams/{team}/participants/{participant}

Default

Path parameters

team integer Required

The ID of the team that the participant belongs to.
participant string Required

The key of the participant.

application/json

Body

key string

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

200 application/json
Hide response attribute Show response attribute object
- data object
  
  Hide data attributes Show data attributes object
  
  id string
  
  type string
  
  attributes object
  
  Hide attributes attributes Show attributes attributes object
  
  id integer
  
  team_id integer
  
  key string
  
  notes string
  
  created object
  
  Hide created attributes Show created attributes object
  
  human string
  
  string string
  
  updated object
  
  Hide updated attributes Show updated attributes object
  
  human string
  
  string string
  
  links object
  
  Hide links attribute Show links attribute object
  
  self object
  
  Hide self attribute Show self attribute object
  
  href string
403 application/json
Hide response attribute Show response attribute object
- message string
404 application/json
Hide response attribute Show response attribute object
- message string
422 application/json
Hide response attributes Show response attributes object
- message string
- errors object
  
  Hide errors attribute Show errors attribute object
  
  key array[string]

PUT /api/teams/{team}/participants/{participant}

curl \
 -X PUT https://checkmango.com/api/teams/13/participants/facilis \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"key":"jbrooksuk","notes":"reprehenderit"}'

Request example

{
  "key": "jbrooksuk",
  "notes": "reprehenderit"
}

Response examples (200)

{
  "data": {
    "id": "MAGNI_AUT_ET_CORPORIS",
    "type": "participants",
    "attributes": {
      "id": 5,
      "team_id": 52,
      "key": "MAGNI_AUT_ET_CORPORIS",
      "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/52/participants/MAGNI_AUT_ET_CORPORIS"
      }
    }
  }
}

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."
    ]
  }
}