Desarrolladores Api Orzame

Personas

Gestiona personas asociadas a contactos.

Crear una persona

Crear una persona asociada a un contacto

Petición HTTP

POST/contacts/{contact_id}/persons

Parámetros

Nombre	Tipo	Descripción
name	Cadena / Obligatoria	Nombre
position	Cadena / Opcional	Cargo o puesto
phone	Cadena / Opcional	Teléfono
email	Cadena / Opcional	Email
default	Boolean / Opcional / true, false (Si no se envía será `false´ por defecto)	Establecer como persona por defecto

Datos petición

{
    "name": "Person name"
}

201Respuesta

{
    "data": {
        "id": 80,
        "name": "Person name",
        "position": "",
        "phone": "",
        "email": "",
        "default": false,
        "contact_id": 120,
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Listar personas

Este endpoint permite la consulta de las personas de un contacto.

Petición HTTP

GET/contacts/{contact_id}/persons

200 Respuesta

{
    "data": [
        {
            "id": 60,
            "name": "Mary",
            "position": "Boss",
            "phone": "",
            "email": "mary@acme.com",
            "default": true,
            "contact_id": 120,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        {
            "id": 65,
            "name": "John Doe",
            "position": "",
            "phone": "999-999-999",
            "email": "jhon.doe@acme.com",
            "default": false,
            "contact_id": 120,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        }
    ]
}

Obtener una persona

Este endpoint permite la consulta de una persona de un contacto.

Petición HTTP

GET/contacts/{contact_id}/persons/{person_id}

200 Respuesta

{
    "data": {
        "id": 80,
        "name": "Person name",
        "position": "",
        "phone": "",
        "email": "",
        "default": false,
        "contact_id": 120,
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-10-30T16:30:25+00:00"
    }
}

Actualizar una persona

Este endpoint permite la actualización de una persona de contacto.

Petición HTTP

PATCH/contacts/{contact_id}/persons/{person_id}

Parámetros

Nombre	Tipo	Descripción
name	Cadena / Opcional	Nombre
position	Cadena / Opcional	Cargo o puesto
phone	Cadena / Opcional	Teléfono
email	Cadena / Opcional	Email
default	Boolean / Opcional	Establecer como persona por defecto

Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.

Datos petición

{
    "name": "New name",
    "email": "person@acme.com",
    "default": true
}

204 Respuesta

Respuesta sin cuerpo.

Eliminar una persona

Este endpoint permite la eliminación de una persona de un contacto.

Petición HTTP

DELETE/contacts/{contact_id}/persons/{person_id}

204 Respuesta

Respuesta sin cuerpo.