{"_id":"5734e681df40390e004aaca2","user":"56abd213d4432d1900eed227","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":18,"createdAt":"2016-01-29T20:57:39.712Z","releaseDate":"2016-01-29T20:57:39.712Z","categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"56b4b2faeed075230097d688","__v":0,"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","pages":[],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-05T14:34:34.496Z","from_sync":false,"order":2,"slug":"contactos","title":"Contactos"},"project":"56abd2434e4b730d009eb10a","editedParams":true,"editedParams2":true,"__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-12T20:24:33.058Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"","language":"text"}]},"settings":"","examples":{"codes":[]},"method":"put","auth":"required","params":[{"_id":"5734ec5d585a7e1700f9dcd4","ref":"","in":"path","required":true,"desc":"Identificador del contacto que se desea editar. Se  debe enviar en la URL","default":"","type":"int","name":"id"},{"_id":"56b0cbcbce5f410d0056c9c7","ref":"","in":"body","required":false,"desc":"Nombre del contacto. Longitud máxima permitida: 90.","default":"","type":"string","name":"name"},{"_id":"56b0cd936d004b17008065cf","ref":"","in":"body","required":false,"desc":"Número de identificación del contacto.   Longitud máxima permitida: 45.","default":"","type":"string","name":"identification"},{"_id":"56b0cd936d004b17008065ce","ref":"","in":"body","required":false,"desc":"Número telefónico principal del contacto.  Longitud máxima permitida: 45.","default":"","type":"string","name":"phonePrimary"},{"_id":"56b0cd936d004b17008065cd","ref":"","in":"body","required":false,"desc":"Número telefónico secundario del contacto.  Longitud máxima permitida: 45.","default":"","type":"string","name":"phoneSecondary"},{"_id":"56b0cd936d004b17008065cc","ref":"","in":"body","required":false,"desc":"Fax del contacto.  Longitud máxima permitida: 45.","default":"","type":"string","name":"fax"},{"_id":"56b11166135ec20d00bafa04","ref":"","in":"body","required":false,"desc":"Número de célular/móvil.  Longitud máxima permitida: 45.","default":"","type":"string","name":"mobile"},{"_id":"56b0cd936d004b17008065cb","ref":"","in":"body","required":false,"desc":"Observaciones del cliente.  Longitud máxima permitida: 500.","default":"","type":"string","name":"observations"},{"_id":"56b0cd936d004b17008065ca","ref":"","in":"body","required":false,"desc":"Correo electrónico del contacto.  Longitud máxima permitida: 100.","default":"","type":"string","name":"email"},{"_id":"56b11233f48f270d00e0dd5c","ref":"","in":"body","required":false,"desc":"Objecto PriceList que indica la lista de precios asociada al contacto. Se puede enviar el id de la lista de precios directamente.","default":"","type":"object","name":"priceList"},{"_id":"56b11233f48f270d00e0dd5b","ref":"","in":"body","required":false,"desc":"Objecto Seller que indica el vendedor asociado al contacto. Se puede enviar el id del vendedor directamente.","default":"","type":"object","name":"seller"},{"_id":"56b11233f48f270d00e0dd5a","ref":"","in":"body","required":false,"desc":"Objecto Term que indica el término de pago del contacto. Se puede enviar el id del término de pago directamente.","default":"","type":"object","name":"term"},{"_id":"56b11233f48f270d00e0dd59","ref":"","in":"body","required":false,"desc":"Objeto Address que contiene la información de la dirección del contacto.  Para las versiones diferentes a Alegra México, este objeto puede contiene los siguientes atributos:  `address (string)`: dirección del contacto; `city (string)`: Ciudad del contacto.  Para Alegra México, este objeto debe contener los atributos : `street (string)`: Calle del contacto; `exteriorNumber (string)` : Número de exterior; `interiorNumber (string)`: Número de interior; `colony (string)`: Colonia del contacto; `country (string, obligatorio)`: país del contacto; `locality (string)`: localidad; `municipality (string)`: Municipio; `state (string, obligatorio)`: estado, `zipCode (number)`: código postal del usuario.","default":"","type":"object","name":"address"},{"_id":"56b11233f48f270d00e0dd58","ref":"","in":"body","required":false,"desc":"Array que incluye el tipo de contacto, las opciones posibles son 'client', 'provider', se puede incluir en el array una de la anteriores opciones, las dos opciones o ninguna. Si solo se desea asociar a un tipo se puede enviar el tipo directamente como String y no en Array.","default":"","type":"array_string","name":"type"},{"_id":"56b11233f48f270d00e0dd57","ref":"","in":"body","required":false,"desc":"Array de objetos internalContact que indica las personas asociadas al contacto.  Cada objeto deben tener los siguientes atributos `name (string, obligatorio)`: nombre del contacto interno;  `lastname (string)`: apellido del contacto interno; `email (string)` : correo electrónico; `phone (string)`: teléfono del contacto; `sendNotifications (boolean)`: enviar true si se desea que a la persona se le envíe notificaciones de vencimiento de factura.","default":"","type":"array_object","name":"internalContacts"}],"url":"/contacts/:id"},"isReference":true,"order":4,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos.\",\n  \"body\": \"\"\n}\n[/block]\nPor ejemplo para editar el nombre de un contacto se debe enviar el siguiente JSON:\n\n```JSON\n{\n\"name\" : \"Nuevo nombre  de mi contacto\"\n}\n```\n\n\nPara eliminar algún dato del contacto enviar el atributo en null, así:\n```JSON\n{\n\"email\" : null\n}\n```\n\nSe retorna el contacto que se ha modificado.","excerpt":"","slug":"editar-contacto","type":"endpoint","title":"Editar contacto"}

putEditar contacto


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Identificador del contacto que se desea editar. Se debe enviar en la URL

Body Params

name:
string
Nombre del contacto. Longitud máxima permitida: 90.
identification:
string
Número de identificación del contacto. Longitud máxima permitida: 45.
phonePrimary:
string
Número telefónico principal del contacto. Longitud máxima permitida: 45.
phoneSecondary:
string
Número telefónico secundario del contacto. Longitud máxima permitida: 45.
fax:
string
Fax del contacto. Longitud máxima permitida: 45.
mobile:
string
Número de célular/móvil. Longitud máxima permitida: 45.
observations:
string
Observaciones del cliente. Longitud máxima permitida: 500.
email:
string
Correo electrónico del contacto. Longitud máxima permitida: 100.
priceList:
object
Objecto PriceList que indica la lista de precios asociada al contacto. Se puede enviar el id de la lista de precios directamente.
seller:
object
Objecto Seller que indica el vendedor asociado al contacto. Se puede enviar el id del vendedor directamente.
term:
object
Objecto Term que indica el término de pago del contacto. Se puede enviar el id del término de pago directamente.
address:
object
Objeto Address que contiene la información de la dirección del contacto. Para las versiones diferentes a Alegra México, este objeto puede contiene los siguientes atributos: `address (string)`: dirección del contacto; `city (string)`: Ciudad del contacto. Para Alegra México, este objeto debe contener los atributos : `street (string)`: Calle del contacto; `exteriorNumber (string)` : Número de exterior; `interiorNumber (string)`: Número de interior; `colony (string)`: Colonia del contacto; `country (string, obligatorio)`: país del contacto; `locality (string)`: localidad; `municipality (string)`: Municipio; `state (string, obligatorio)`: estado, `zipCode (number)`: código postal del usuario.
type:
array of strings
Array que incluye el tipo de contacto, las opciones posibles son 'client', 'provider', se puede incluir en el array una de la anteriores opciones, las dos opciones o ninguna. Si solo se desea asociar a un tipo se puede enviar el tipo directamente como String y no en Array.
internalContacts:
array of objects
Array de objetos internalContact que indica las personas asociadas al contacto. Cada objeto deben tener los siguientes atributos `name (string, obligatorio)`: nombre del contacto interno; `lastname (string)`: apellido del contacto interno; `email (string)` : correo electrónico; `phone (string)`: teléfono del contacto; `sendNotifications (boolean)`: enviar true si se desea que a la persona se le envíe notificaciones de vencimiento de factura.

Documentation

[block:callout] { "type": "warning", "title": "Únicamente se modifican los atributos que se envían en el request, los otros atributos del objeto que no se envían quedan intactos.", "body": "" } [/block] Por ejemplo para editar el nombre de un contacto se debe enviar el siguiente JSON: ```JSON { "name" : "Nuevo nombre de mi contacto" } ``` Para eliminar algún dato del contacto enviar el atributo en null, así: ```JSON { "email" : null } ``` Se retorna el contacto que se ha modificado.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}