Skip to main content
POST
Identify a contact

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

The contact identifier — email address, phone number, public portal ID (PID), or internal contact ID.

traits
object

Contact fields to create or update (e.g. first_name, last_name, mobile, any org-defined field). Pass "$process": 2 inside traits for synchronous processing (see response section).

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

Empty for a batch (array) payload — that path returns [] with message "queued N". Also empty for a single payload unless traits.$process = 2.