Skip to main content
POST
Create a user

Authorizations

x-conveyour-token
string
header
required

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

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
email
string
required

The new user's email address.

first_name
string
required

First name.

last_name
string
required

Last name.

role
string

User role: admin, rep, guest, etc.

teams
string[]

Array of team IDs to assign the user to (for guest users).

timezone
string

User's timezone (e.g. America/New_York).

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

Create returns only the new user id.