APIContacts
Create contact
Create a contact. Requires the contacts:write scope.
POST
/contactscurl -X POST "https://productlane.com/api/v2/contacts" \
-H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]"
}'Authorization
AuthorizationstringheaderrequiredBearer authentication header of the form
Bearer <token>, where<token>is your auth token.
Body
application/json
emailstring<email>requirednamestringimage_urlstring<uri> | nullAvatar URL. Omit to auto-resolve from Gravatar;
nullstores no avatar.is_subscribedbooleanReceives changelog and per-project/issue update emails. Defaults to
true.external_idsstring[]Caller-owned identifiers. Replaces the full set.
company_idstringProductlane company id. Mutually exclusive with
company_nameandcompany_external_id.company_namestringResolves a company by exact name. Errors if multiple companies share the name.
company_external_idstringResolves a company by an entry in its
external_idsarray.
Response
application/json
Successful response
idstringrequiredemailstring | nullrequiredNull for a contact created with only
contact_external_id, such as a phone number.namestring | nullrequiredimage_urlstring | nullrequiredcompany_idstring | nullrequiredis_subscribedbooleanrequiredexternal_idsstring[]requiredCaller-owned cross-system identifiers (CRM ids, etc.). Replaced wholesale on create/update.
integration_idsobjectrequiredcreated_atstringrequiredupdated_atstringrequired
{
"id": "string",
"email": "string",
"name": "string",
"image_url": "string",
"company_id": "string",
"is_subscribed": true,
"external_ids": [
"string"
],
"integration_ids": {
"intercom": "string",
"front": "string",
"zendesk": "string",
"hubspot": "string",
"plain": "string",
"productboard": "string",
"slack_channel": "string"
},
"created_at": "string",
"updated_at": "string"
}