Teams: Create

This documentation entry provides a clear guide for developers on how to create a new team using the API, including the necessary parameters, headers, and expected response.

Endpoint

POST /api/teams

Create a new team with the specified parameters.

Request

HTTP Request

POST https://uptimekeep.com/api/teams

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

name

String

Yes

The name of the team.

Example of a request:

curl --request POST \
--url 'https://uptimekeep.com/api/teams' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My team'

Response

A successful response returns a JSON object containing the unique identifier of the newly created team.

Response Example

Fields

Data Object

Field
Type
Description

id

Integer

Unique identifier for the new team.

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.

Last updated