Create a contact
Creates a contact. A contact with the same phone, e-mail or identifier already in the
workspace answers 409 contact_exists with its id in details.id — nothing is created.
Authorization
personalToken Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.
In: header
Header Parameters
The workspace to work in (an id from GET /me). Optional when you belong to a single
workspace; required otherwise (400 workspace_required).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://app.lalexi.com/v1/contacts" \ -H "X-Workspace-Id: 7" \ -H "Content-Type: application/json" \ -d '{ "name": "Anna Petrova", "phone": "+7 900 000-00-01", "labels": [ "lead" ], "custom_attributes": { "tier": "gold" } }'{
"id": 0,
"name": "string",
"phone": "string",
"email": "string",
"identifier": "string",
"social_profiles": {
"property1": "string",
"property2": "string"
},
"labels": [
"string"
],
"custom_attributes": {},
"blocked": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_activity_at": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "workspace_required",
"message": "You belong to several workspaces: pass the X-Workspace-Id header."
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is missing or invalid."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to do this."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found."
}
}{
"error": {
"code": "contact_exists",
"message": "A contact with this phone, email or identifier exists.",
"details": {
"id": 1042
}
}
}{
"error": {
"code": "validation_failed",
"message": "The request is invalid.",
"details": {
"email": [
"is invalid"
]
}
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the number of seconds in Retry-After."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side."
}
}