> ## Documentation Index > Fetch the complete documentation index at: https://docs.periskope.app/llms.txt > Use this file to discover all available pages before exploring further. # Update Contact > This endpoint updates properties of a contact ## OpenAPI ````yaml PATCH /contacts/{contact_id} openapi: 3.0.3 info: title: API - Local description: >- #### Welcome to the official Postman collection of Periskope API Periskope APIs enable you automate actions on your WhatsApp phone, and the Periskope platform - Read more about the APIs & webhooks here - [https://docs.periskope.app/api-reference/introduction](https://docs.periskope.app/api-reference/introduction) - We encourage responsible usage of the APIs. Follow these best practices and recommendations for safe actions on WhatsApp - [https://docs.periskope.app/get-started/best-practices](https://docs.periskope.app/get-started/best-practices) #### Getting Started ##### Pre-requisites: 1. **Sign up for a free account on Periskope:** To use the Periskope API, you need to have an active Periskope account. If you don’t have one, you can sign up for a 7-day free trial [here](https://console.periskope.app). 2. **Scan the QR code from WhatsApp to connect your phone:** A connected phone is required to use the APIs 3. **Go to** [Settings > API](https://console.periskope.app/settings/api), and generate an API key for your organization - The API key is used to authenticate every request. Please keep this secure ##### Using Postman: 1. **Fork the collection so you can edit values and test the APIs in your own postman environment:** To fork the collection, click on the three dots next to v1. Then click on create a fork (_shortcut: Ctrl + Alt + F)._ 2. **Update the value of the variables in the collection:** \- Update the API key with the key generated in Step 3 \- Update the phone number with your connected number. This number will be added to the `x-phone` header across requests It must be in the format of country code+number, with no special characters or spaces _e.g. +91 98745 32456 becomes 919874532456_ For any help or feedback, please contact us at [support@periskope.app](https://mailto:support@periskope.app), or ping us on [WhatsApp](https://what.sapp.link/periskope) version: 1.0.0 contact: {} servers: - url: https://api.periskope.app/v1 security: - bearerAuth: [] tags: - name: contacts - name: tickets - name: tasks - name: phones - name: message - name: queue - name: chats - name: group - name: members - name: webhooks - name: custom properties paths: /contacts/{contact_id}: parameters: - name: contact_id in: path required: true schema: type: string example: '919537851844' description: >- - The unique identifier of the contact - Must be formatted as `country_code + number` (e.g., `918527184400`). Do not include special characters patch: tags: - contacts summary: Update Contact description: | This endpoint updates properties of a contact operationId: updateContact requestBody: content: application/json: schema: type: object properties: contact_name: type: string example: BK Local1 description: >- Update the contact name. Note that this name will only be updated on Periskope (not on the phone) is_internal: type: boolean example: false description: >- Mark the contact as internal. Messages from internal contacts are not flagged labels: type: string example: label1,label2 description: >- - A comma-separated list of labels to be assigned to the contacts. All labels are case-insensitive. - If any label currently does not exist, it will be created examples: Update Contact: value: '' responses: '200': description: 200 OK headers: Access-Control-Allow-Origin: schema: type: string example: '*' Connection: schema: type: string example: keep-alive Content-Length: schema: type: string example: '1122' Date: schema: type: string example: Wed, 22 Jan 2025 05:41:15 GMT ETag: schema: type: string example: W/"462-0rPwaW+Fj8VvXIYvQljXw3jb+mo" Keep-Alive: schema: type: string example: timeout=5 X-Powered-By: schema: type: string example: Express X-RateLimit-Limit: schema: type: string example: '10' X-RateLimit-Remaining: schema: type: string example: '9' X-RateLimit-Reset: schema: type: string example: '1737524477' x-periskope-org-id: schema: type: string example: 2997dd64-89bf-48d3-9a22-b314fca017e5 x-periskope-trace-id: schema: type: string example: 7eccef90-d883-11ef-beed-29f3a0897836 content: application/json: schema: type: object description: >- The response is a contact object. Refer to [the contact object here](/api-reference/objects/the-contact-object) examples: 200 OK: value: chat_ids: - 120363231636311517@g.us - 120363298090795525@g.us - 120363300395249001@g.us - 120363329861739657@g.us - 120363331984403446@g.us - 120363346994879209@g.us - 120363348209472631@g.us - 120363352652386702@g.us - 120363363215130488@g.us - 120363367240230358@g.us - 120363370646127343@g.us - 120363371655584481@g.us - 120363372525172897@g.us - 120363373761356282@g.us - 120363378751945209@g.us - 120363387379991154@g.us - 120363387670530253@g.us - 120363388696354849@g.us - 120363389171465741@g.us - 120363391093262494@g.us - 120363392706769636@g.us - 919537851844@c.us contact_color: '#FA6533' contact_id: 919537851844@c.us contact_image: >- https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737445692504 contact_name: BK Local1 contact_type: user is_imported: null is_internal: false is_my_contact: null is_wa_contact: false label_ids: label-ukjqhqngnakncalm: true label-wwfrdqogccexahnv: true labels: - label1 - label2 org_id: 2997dd64-89bf-48d3-9a22-b314fca017e5 updated_at: '2025-01-22T05:41:15.303874+00:00' '422': description: 422 Invalid body headers: Access-Control-Allow-Origin: schema: type: string example: '*' Connection: schema: type: string example: keep-alive Content-Length: schema: type: string example: '331' Date: schema: type: string example: Thu, 09 Jan 2025 09:06:33 GMT ETag: schema: type: string example: W/"14b-OgA1a8dT2GDWm6C5BcV2jgb9Itk" Keep-Alive: schema: type: string example: timeout=5 X-Powered-By: schema: type: string example: Express X-RateLimit-Limit: schema: type: string example: '10' X-RateLimit-Remaining: schema: type: string example: '9' X-RateLimit-Reset: schema: type: string example: '1736413595' org_id: schema: type: string example: 2997dd64-89bf-48d3-9a22-b314fca017e5 x-periskope-trace-id: schema: type: string example: 05853a80-ce69-11ef-940a-49a43c3e869b content: application/json: schema: type: object properties: code: type: string example: VALIDATION_ERROR fields: type: object properties: contact_name: type: object properties: message: type: string example: contact_name is missing is_internal: type: object properties: message: type: string example: is_internal is missing labels: type: object properties: message: type: string example: labels is missing message: type: string example: >- Invalid body. At least one of the following keys are required: contact_name, is_internal, labels name: type: string example: Validation Error status: type: number example: 422 examples: 422 Invalid body: value: code: VALIDATION_ERROR fields: contact_name: message: contact_name is missing is_internal: message: is_internal is missing labels: message: labels is missing message: >- Invalid body. At least one of the following keys are required: contact_name, is_internal, labels name: Validation Error status: 422 x-codeSamples: - lang: TypeScript label: Node.js source: |- import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210' }); async function updateContact() { const response = await client.contact.update({ contact_id: '919537851844', contact_name: 'Periskope test' }); console.log(response); } updateContact(); - lang: cURL label: cURL source: |- curl -X PATCH \ https://api.periskope.app/v1/contacts/{contact_id} \ -H 'Authorization: Bearer ' \ -H 'Content-Type: application/json' \ -H 'x-phone: YOUR_PHONE_NUMBER' \ -d '{ "contact_name": "Periskope test" }' components: securitySchemes: bearerAuth: type: http scheme: bearer ````