Add API endpoint to update contact by email with request and response schemas

2026-08-17 21:25:54 +02:00 · 2026-08-06 20:28:28 +05:30
parent e296bff3b1
commit c5f5fca403
2 changed files with 144 additions and 0 deletions
@@ -318,6 +318,57 @@ paths:
                $ref: '#/components/schemas/invalidtoken'
      security:
      - x-api-token: []
+  /contact-by-email/{email}:
+    put:
+      tags:
+      - Contacts
+      summary: Update Contact by Email
+      description: The Update Contact by Email API enables you to modify and update the details of a specific Contact using their email address as the identifier, instead of the contact ID.
+      operationId: updateContactByEmail
+      parameters:
+      - name: email
+        in: path
+        description: Email address of the contact
+        required: true
+        style: simple
+        explode: false
+        schema:
+          type: string
+          format: string
+          example: joebee@example.com
+      requestBody:
+        description: Provide the fields you wish to update. Any fields omitted from the request will remain unchanged.
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/updatecontactbyemail_body'
+      responses:
+        "200":
+          description: Contact updated successfully!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/inline_response_200_14'
+        "400":
+          description: Please provide valid field names!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/inline_response_400'
+        "404":
+          description: Contact not found!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/inline_response_404_7'
+        "405":
+          description: Invalid API Token!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/invalidtoken'
+      security:
+      - x-api-token: []
  /contactlist:
    get:
      tags:
@@ -5376,6 +5427,27 @@ components:
          example: dev
      xml:
        name: contactdetails 
+    updatecontactbyemail_body:
+      type: object
+      properties:
+        name:
+          type: string
+          format: string
+          example: joe bee
+        phone:
+          type: string
+          format: string
+          example: "4131231231"
+        company:
+          type: string
+          format: string
+          example: opensign
+        job_title:
+          type: string
+          format: string
+          example: dev
+      xml:
+        name: contactdetails 
    folder:
      type: object
      properties:
@@ -397,6 +397,57 @@ paths:
                $ref: '#/components/schemas/invalidtoken'
      security:
      - x-api-token: []
+  /contact-by-email/{email}:
+    put:
+      tags:
+      - Contacts
+      summary: Update Contact by Email
+      description: The Update Contact by Email API enables you to modify and update the details of a specific Contact using their email address as the identifier.
+      operationId: updateContactByEmail
+      parameters:
+      - name: email
+        in: path
+        description: Email address of the contact
+        required: true
+        style: simple
+        explode: false
+        schema:
+          type: string
+          format: string
+          example: joebee@example.com
+      requestBody:
+        description: Provide the fields you wish to update. Any fields omitted from the request will remain unchanged.
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/updatecontactbyemail_body'
+      responses:
+        "200":
+          description: Contact updated successfully!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/inline_response_200_14'
+        "400":
+          description: Please provide valid field names!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/inline_response_400'
+        "404":
+          description: Contact not found!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/inline_response_404_7'
+        "405":
+          description: Invalid API Token!
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/invalidtoken'
+      security:
+      - x-api-token: []
  /contactlist:
    get:
      tags:
@@ -5570,6 +5621,27 @@ components:
          example: dev
      xml:
        name: contactdetails 
+    updatecontactbyemail_body:
+      type: object
+      properties:
+        name:
+          type: string
+          format: string
+          example: joe bee
+        phone:
+          type: string
+          format: string
+          example: "4131231231"
+        company:
+          type: string
+          format: string
+          example: opensign
+        job_title:
+          type: string
+          format: string
+          example: dev
+      xml:
+        name: contactdetails 
    folder:
      type: object
      properties: