From c5f5fca4037013f50485f7477f182199fe51374b Mon Sep 17 00:00:00 2001 From: RaktimaNXG Date: Thu, 6 Aug 2026 20:28:28 +0530 Subject: [PATCH] Add API endpoint to update contact by email with request and response schemas --- docs/docs/API-docs/v1.1/opensign.yaml | 72 +++++++++++++++++++++++++++ docs/docs/API-docs/v1.2/opensign.yaml | 72 +++++++++++++++++++++++++++ 2 files changed, 144 insertions(+) diff --git a/docs/docs/API-docs/v1.1/opensign.yaml b/docs/docs/API-docs/v1.1/opensign.yaml index 2ad463937..d84226f78 100644 --- a/docs/docs/API-docs/v1.1/opensign.yaml +++ b/docs/docs/API-docs/v1.1/opensign.yaml @@ -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: diff --git a/docs/docs/API-docs/v1.2/opensign.yaml b/docs/docs/API-docs/v1.2/opensign.yaml index 6d5875d32..504e45e38 100644 --- a/docs/docs/API-docs/v1.2/opensign.yaml +++ b/docs/docs/API-docs/v1.2/opensign.yaml @@ -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: