La agenda de contactos se utiliza para crear participaciones de manera más ágil. Si al crear una participación se envía el Id del contacto, se autocompletan los datos de la misma.
POST➜ /v2/contactos
https://api.contractia.app/v2/contactos
🧾 Parámetros del cuerpo (JSON)
| Parámetro | Tipo | Descripción |
|---|---|---|
id | int | Identificador único del contacto, se genera automáticamente |
nombre | string | Nombre del contacto |
apellido | string | Apellido del contacto |
mail | string | Correo electrónico |
telefonos | array[telefono] | |
telefono{ | ||
id | int | Identificador único del teléfono, se genera automáticamente |
codigo_pais | string | Código teléfonico del país |
numero | string | Número de teléfono |
referencia | string | Etiqueta opcional para identificar el número |
| } |
🔁 Respuestas posibles
| Código | Descripción |
|---|---|
| 200 OK | Devuelve el id único del contacto creado. |
| 400 Bad Request | "Ya existe un contacto con el mail {{mail}} / "Lo sentimos, ocurrió un error creando el contacto" |
| 403 Forbidden | "No tiene permisos" o "Acceso denegado" |
| 500 Internal Server Error | "Ocurrió un error creando la tarea" |
💻 Ejemplo de implementación
- cURL
- Request JSON
- Response JSON
curl --location --request POST 'https://api.contractia.app/v2/contactos' \
--header 'Authorization: Bearer {{api_key}}' \
--header 'user_id: {{user_id}}' \
--header 'Content-Type: application/json' \
--data '{
"id": 0,
"nombre": "José",
"apellido": "García",
"mail": "correojosegarcia@yopmail.com",
"telefonos": [
{
"id": 0,
"codigo_pais": "54",
"numero": "1131112222",
"referencia": "Celular laboral"
}
]
}'
{
"id": 0,
"nombre": "María",
"apellido": "González",
"mail": "correogonzalezm@yopmail.com",
"telefonos": [
]
}
{
"status": 400,
"message": "El correo electrónico ingresado pertenece a otro contacto de su agenda",
"code": null,
"timestamp": "2024-08-12T16:05:44.1503502+00:00"
}