Teams Members: Update

Detailed guide on how to update the status of an existing team member using the API, including the necessary parameters, headers, and expected response.

Endpoint

POST /api/teams-member/{team_member_id}

Update the status of an existing team member by specifying their unique identifier.

Request

HTTP Request

POST https://uptimekeep.com/api/teams-member/{team_member_id}

Replace {team_member_id} with the ID of the team member you wish to update.

Headers

Header	Type	Description
Authorization	String	Bearer token for API authentication.
Content-Type	String	Must be set to multipart/form-data for file uploads.

Parameters

Parameter	Type	Required	Description
status	Boolean	No	The new status for the team member (e.g., 1 for active, 0 for inactive).

Example of a request:

curl --request POST \
--url 'https://uptimekeep.com/api/teams-member/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'status=1'

Response

A successful response returns a JSON object containing the unique identifier of the updated team member.

Response Example

{
    "data": {
        "id": 1
    }
}

Fields

Data Object

Field	Type	Description
id	Integer	Unique identifier for the updated team member.

Errors

If the request fails, the API will return an error message with an appropriate HTTP status code, such as 400 Bad Request if required parameters are missing or invalid, or 404 Not Found if the team member ID does not exist.