{"note":"OpenAPI conversion -- returning structured metadata","name":"apideck-com-customer-support","description":"Customer Support","version":"9.5.0","base_url":"https://unify.apideck.com","endpoints":5,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Customer Support\n@base https://unify.apideck.com\n@version 9.5.0\n@auth ApiKey Authorization in header\n@endpoints 5\n@toc customer-support(5)\n\n@endpoint GET /customer-support/customers\n@desc List Customer Support Customers\n@required {x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {raw: bool=false # Include raw response. Mostly used for debugging purposes, x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., cursor: str # Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response., limit: int=20 # Number of results to return. Minimum 1, Maximum 200, Default 20, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: [map], meta: map{items_on_page: int, cursors: map{previous: str?, current: str?, next: str?}}, links: map{previous: str?, current: str, next: str?}} # CustomerSupportCustomers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint POST /customer-support/customers\n@desc Create Customer Support Customer\n@required {x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {raw: bool=false # Include raw response. Mostly used for debugging purposes, x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., id: str # A unique identifier for an object., company_name: str # The name of the company., first_name: str # The first name of the person., last_name: str # The last name of the person., individual: bool, addresses: [map{id: str, type: str, string: str, name: str, line1: str, line2: str, line3: str, line4: str, street_number: str, city: str, state: str, postal_code: str, country: str, latitude: str, longitude: str, county: str, contact_name: str, salutation: str, phone_number: str, fax: str, email: str, website: str, row_version: str}], notes: str, phone_numbers: [map{id: str, country_code: str, area_code: str, number!: str, extension: str, type: str}], emails: [map{id: str, email!: str(email), type: str}], tax_number: str, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., bank_accounts: map{account_number: str, account_name: str, account_type: str, iban: str, bic: str, bsb_number: str, branch_identifier: str, bank_code: str, currency: str}, status: str(active/archived/gdpr-erasure-request/unknown) # Customer status, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created.}\n@returns(201) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}} # CustomerSupportCustomers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint GET /customer-support/customers/{id}\n@desc Get Customer Support Customer\n@required {id: str # ID of the record you are acting upon., x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., raw: bool=false # Include raw response. Mostly used for debugging purposes, fields: str # The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city`In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str, company_name: str?, first_name: str?, last_name: str?, individual: bool?, addresses: [map], notes: str?, phone_numbers: [map], emails: [map], tax_number: str?, currency: str?, bank_accounts: map{account_number: str?, account_name: str?, account_type: str?, iban: str?, bic: str?, bsb_number: str?, branch_identifier: str?, bank_code: str?, currency: str?}, status: str?, updated_by: str?, created_by: str?, updated_at: str(date-time)?, created_at: str(date-time)}} # CustomerSupportCustomers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint PATCH /customer-support/customers/{id}\n@desc Update Customer Support Customer\n@required {id: str # ID of the record you are acting upon., x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., raw: bool=false # Include raw response. Mostly used for debugging purposes, id: str # A unique identifier for an object., company_name: str # The name of the company., first_name: str # The first name of the person., last_name: str # The last name of the person., individual: bool, addresses: [map{id: str, type: str, string: str, name: str, line1: str, line2: str, line3: str, line4: str, street_number: str, city: str, state: str, postal_code: str, country: str, latitude: str, longitude: str, county: str, contact_name: str, salutation: str, phone_number: str, fax: str, email: str, website: str, row_version: str}], notes: str, phone_numbers: [map{id: str, country_code: str, area_code: str, number!: str, extension: str, type: str}], emails: [map{id: str, email!: str(email), type: str}], tax_number: str, currency: str(UNKNOWN_CURRENCY/AED/AFN/ALL/AMD/ANG/AOA/ARS/AUD/AWG/AZN/BAM/BBD/BDT/BGN/BHD/BIF/BMD/BND/BOB/BOV/BRL/BSD/BTN/BWP/BYR/BZD/CAD/CDF/CHE/CHF/CHW/CLF/CLP/CNY/COP/COU/CRC/CUC/CUP/CVE/CZK/DJF/DKK/DOP/DZD/EGP/ERN/ETB/EUR/FJD/FKP/GBP/GEL/GHS/GIP/GMD/GNF/GTQ/GYD/HKD/HNL/HRK/HTG/HUF/IDR/ILS/INR/IQD/IRR/ISK/JMD/JOD/JPY/KES/KGS/KHR/KMF/KPW/KRW/KWD/KYD/KZT/LAK/LBP/LKR/LRD/LSL/LTL/LVL/LYD/MAD/MDL/MGA/MKD/MMK/MNT/MOP/MRO/MUR/MVR/MWK/MXN/MXV/MYR/MZN/NAD/NGN/NIO/NOK/NPR/NZD/OMR/PAB/PEN/PGK/PHP/PKR/PLN/PYG/QAR/RON/RSD/RUB/RWF/SAR/SBD/SCR/SDG/SEK/SGD/SHP/SLL/SOS/SRD/SSP/STD/SVC/SYP/SZL/THB/TJS/TMT/TND/TOP/TRC/TRY/TTD/TWD/TZS/UAH/UGX/USD/USN/USS/UYI/UYU/UZS/VEF/VND/VUV/WST/XAF/XAG/XAU/XBA/XBB/XBC/XBD/XCD/XDR/XOF/XPD/XPF/XPT/XTS/XXX/YER/ZAR/ZMK/ZMW/BTC/ETH) # Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)., bank_accounts: map{account_number: str, account_name: str, account_type: str, iban: str, bic: str, bsb_number: str, branch_identifier: str, bank_code: str, currency: str}, status: str(active/archived/gdpr-erasure-request/unknown) # Customer status, updated_by: str # The user who last updated the object., created_by: str # The user who created the object., updated_at: str(date-time) # The date and time when the object was last updated., created_at: str(date-time) # The date and time when the object was created.}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}} # CustomerSupportCustomers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@endpoint DELETE /customer-support/customers/{id}\n@desc Delete Customer Support Customer\n@required {id: str # ID of the record you are acting upon., x-apideck-consumer-id: str # ID of the consumer which you want to get or push data from, x-apideck-app-id: str # The ID of your Unify application}\n@optional {x-apideck-service-id: str # Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API., raw: bool=false # Include raw response. Mostly used for debugging purposes}\n@returns(200) {status_code: int, status: str, service: str, resource: str, operation: str, data: map{id: str}} # CustomerSupportCustomers\n@errors {400: Bad Request, 401: Unauthorized, 402: Payment Required, 404: The specified resource was not found, 422: Unprocessable}\n\n@end\n"}