Skip to main content
PUT
Update a team

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

id
string
required

The id identifier.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
label
string

Updated human-readable team name. Must remain unique within the org.

name
string

Updated machine name. Must remain unique and use tag format.

filters
object

Updated contact filter definition.

contact_fields
string[]

Updated list of contact fields.

color
string

Updated display color.

sms_autoreply
string

Updated SMS auto-reply message.

block_sms
boolean

Updated SMS blocking flag.

portal_new_conversation
boolean

Updated portal new-conversation setting.

contact_desc
string

Updated Liquid contact-description template.

sendblue_number
string

Updated SendBlue phone number.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

A team. Fields are.