Skip to main content
POST
Create team

Authorizations

Authorization
string
header
required

Authenticate with an API access token in the Authorization header: Authorization: Bearer <token>. Create a token from the API Access Tokens page in Contractors Cloud, under Integrations.

Body

application/json
name
string
required

The team's name. Required.

Maximum string length: 50
Example:

"Roofing Sales Team"

leader_id
integer
required

The id of the user who leads this team. Required; must reference a user in your organization.

Example:

1159

is_active
boolean

Whether the team is active. Optional; defaults to true.

Example:

true

comment
string | null

Free-form notes about the team. Optional.

Maximum string length: 65535

Response

The created team.

id
integer

The team's unique identifier.

Example:

501

tenant_id
integer

The id of your organization's account.

Example:

12

leader_id
integer

The id of the user who leads this team.

Example:

1159

name
string

The team's name.

Example:

"Roofing Sales Team"

comment
string | null

Free-form notes about the team. Null if not set.

is_active
boolean

Whether the team is active. Teams aren't deleted through the API — set this to false to deactivate one.

Example:

true