Skip to main content
POST
Create a record

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

The ID of the Custom Object type this record belongs to.

external_id
string

Optional unique identifier linking this record to an external system.

...
string

The record's field values, posted flat at the top level (matching the field names defined in the Custom Object schema). There is no data wrapper.

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 custom object record. The field set varies per organization and per object: the parent object's stored schema is merged over the defaults.