apideck.lead
Module apideck.lead
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_apideck.lead_1.2.0.png)
ballerinax/apideck.lead Ballerina library
Overview
This is a generated connector from Apideck Lead API v5.3.0 OpenAPI specification.
You can use this API to access all Lead API endpoints.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Apideck account
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
apideck.lead: Client![](/images/permalink.svg)
This is a generated connector from Apideck Lead API v5.3.0 OpenAPI specification. You can use this API to access all Lead API endpoints.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Unify API accounts have sandbox mode and live mode API keys. To change modes just use the appropriate key to get a live or test object.
You can find your API keys on the unify settings of your Apideck app.Your Apideck application_id can also be found on the same page.
Obtain API keys following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://unify.apideck.com" - URL of the target service
leadsAll![](/images/permalink.svg)
function leadsAll(string xApideckConsumerId, string xApideckAppId, boolean raw, string? xApideckServiceId, string? cursor, int 'limit) returns InlineResponse200|error
List leads
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- raw boolean (default true) - Include raw response. Mostly used for debugging purposes
- xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- cursor string? (default ()) - Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
- 'limit int (default 20) - Number of records to return
Return Type
- InlineResponse200|error - Leads
leadsAdd![](/images/permalink.svg)
function leadsAdd(string xApideckConsumerId, string xApideckAppId, Lead payload, boolean raw, string? xApideckServiceId) returns InlineResponse201|error
Create lead
Parameters
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- payload Lead - Lead information
- raw boolean (default true) - Include raw response. Mostly used for debugging purposes
- xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
Return Type
- InlineResponse201|error - Lead created
leadsOne![](/images/permalink.svg)
function leadsOne(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns InlineResponse2001|error
Get lead
Parameters
- id string - ID of the record you are acting upon.
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type
- InlineResponse2001|error - Lead
leadsDelete![](/images/permalink.svg)
function leadsDelete(string id, string xApideckConsumerId, string xApideckAppId, string? xApideckServiceId, boolean raw) returns InlineResponse201|error
Delete lead
Parameters
- id string - ID of the record you are acting upon.
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type
- InlineResponse201|error - Lead deleted
leadsUpdate![](/images/permalink.svg)
function leadsUpdate(string id, string xApideckConsumerId, string xApideckAppId, Lead payload, string? xApideckServiceId, boolean raw) returns InlineResponse201|error
Update lead
Parameters
- id string - ID of the record you are acting upon.
- xApideckConsumerId string - ID of the consumer which you want to get or push data from
- xApideckAppId string - The ID of your Unify application
- payload Lead - Lead information
- xApideckServiceId string? (default ()) - Provide the service id you want to call (e.g., pipedrive). See the full list in the connector section. Only needed when a consumer has activated multiple integrations for a Unified API.
- raw boolean (default true) - Include raw response. Mostly used for debugging purposes
Return Type
- InlineResponse201|error - Lead updated
Records![](/images/permalink.svg)
apideck.lead: Address![](/images/permalink.svg)
Fields
- id string? - ID
- 'type string? - Address type
- 'string string? - The address string. Some APIs don't provide structured address data.
- name string? - Name
- line1 string? - Line 1 of the address e.g. number, street, suite, apt #, etc.
- line2 string? - Line 2 of the address
- city string? - Name of city.
- state string? - Name of state
- postal_code string? - Zip code or equivalent.
- country string? - country code according to ISO 3166-1 alpha-2.
- latitude string? - Latitude
- longitude string? - Longitude
apideck.lead: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys.
To change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app.
Your Apideck application_id can also be found on the same page.
Authenticate your API requests by including your test or live secret API key in the request header.
- Bearer authorization header:
Authorization: Bearer <your-apideck-api-key>
- Application id header:
x-apideck-app-id: <your-apideck-app-id>
- Bearer authorization header:
apideck.lead: BadRequest![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: BankAccount![](/images/permalink.svg)
Fields
- iban string? -
- bic string? -
- bsb_number string? - A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.
- bank_code string? - A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.
- account_number string? - A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.
- account_name string? - The name which you used in opening your bank account.
apideck.lead: CustomField![](/images/permalink.svg)
Fields
- id string - ID
apideck.lead: Email![](/images/permalink.svg)
Fields
- id string? - ID
- email string - Email address
- 'type string? - Email type
apideck.lead: InlineResponse200![](/images/permalink.svg)
Fields
- status_code int - HTTP Response Status Code
- status string - HTTP Response Status
- 'service string - Apideck ID of service provider
- 'resource string - Unified API resource name
- operation string - Operation performed
- data Lead[] -
- meta Meta? - Reponse metadata
- links Links? - Links to navigate to previous or next pages through the API
apideck.lead: InlineResponse2001![](/images/permalink.svg)
Fields
- status_code int - HTTP Response Status Code
- status string - HTTP Response Status
- 'service string - Apideck ID of service provider
- 'resource string - Unified API resource name
- operation string - Operation performed
- data Lead -
apideck.lead: InlineResponse201![](/images/permalink.svg)
Fields
- status_code int - HTTP Response Status Code
- status string - HTTP Response Status
- 'service string - Apideck ID of service provider
- 'resource string - Unified API resource name
- operation string - Operation performed
- data UnifiedId -
apideck.lead: Lead![](/images/permalink.svg)
Fields
- id string? - Lead ID
- name string - Lead name
- company_name string - Company name
- owner_id string? - Owner ID
- company_id string? - Company ID
- contact_id string? - Contact ID
- lead_source string? - Lead source
- first_name string? - First name
- last_name string? - Last name
- description string? - Lead description
- prefix string? - Salutation
- title string? - Title
- language string? - language code according to ISO 639-1. For the United States - EN
- status string? - Comapny status
- monetary_amount decimal? - Monetory amount
- currency string? - Currency
- fax string? - Fax number
- websites Website[]? - Company websites
- addresses Address[]? - Company addresses
- social_links SocialLink[]? - Social links
- phone_numbers PhoneNumber[]? - Phone numbers
- emails Email[]? - Emails
- custom_fields CustomField[]? - Custom fields
- tags Tags? -
- updated_at string? - Updated date
- created_at string? - Created date
apideck.lead: Links![](/images/permalink.svg)
Links to navigate to previous or next pages through the API
Fields
- previous string? - Link to navigate to the previous page through the API
- current string? - Link to navigate to the current page through the API
- next string? - Link to navigate to the previous page through the API
apideck.lead: Meta![](/images/permalink.svg)
Reponse metadata
Fields
- items_on_page int? - Number of items returned in the data property of the response
- cursors MetaCursors? - Cursors to navigate to previous or next pages through the API
apideck.lead: MetaCursors![](/images/permalink.svg)
Cursors to navigate to previous or next pages through the API
Fields
- previous string? - Cursor to navigate to the previous page of results through the API
- current string? - Cursor to navigate to the current page of results through the API
- next string? - Cursor to navigate to the next page of results through the API
apideck.lead: NotFoundResponse![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: NotImplemented![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: PaymentRequired![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: PhoneNumber![](/images/permalink.svg)
Fields
- id string? - ID
- number string - Phone number
- 'type string? - Type
apideck.lead: SocialLink![](/images/permalink.svg)
Fields
- id string? - ID
- url string - Social link
- 'type string? - Type
apideck.lead: Unauthorized![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: UnexpectedError![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string|record {}? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: UnifiedId![](/images/permalink.svg)
Fields
- id string - Unified ID
apideck.lead: Unprocessable![](/images/permalink.svg)
Fields
- status_code decimal? - HTTP status code
- _error string? - Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
- type_name string? - The type of error returned
- message string? - A human-readable message providing more details about the error.
- detail string? - Contains parameter or domain specific information related to the error and why it occured.
- ref string? - Link to documentation of error type
apideck.lead: Website![](/images/permalink.svg)
Fields
- id string? - ID
- url string - Website URL
- 'type string? - Type
Import
import ballerinax/apideck.lead;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Freemium
Contributors
Dependencies