Skip to main content
POST
Bulk create records

Authorizations

x-conveyour-token
string
header
required

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

Query Parameters

obj_id
string

The ID of the Custom Object type to scope these records to. Can also be passed in each record object as obj_id.

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
Maximum array length: 100
external_id
string
required

REQUIRED. Match key for the upsert; a record missing it is returned with status "error" and external_id "MISSING".

obj_id
string

Custom object ID. Falls back to the scoped obj_id when omitted.

{key}
any

Any field defined on the custom object's schema.

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[]

One entry per submitted record. The request is capped at 100 records — more returns HTTP 429.