Apideck Vault is here!Learn more

Search docs

CRM API Reference

One single API to push and pull data from multiple connectors.

Base URL

The base URL for all API requests is https://unify.apideck.com

GraphQL

Use the GraphQL playground to test out the GraphQL API.

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

Name Type Required Description
x-apideck-consumer-id String Yes The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-service-id String No Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-raw Boolean No Include raw response. Mostly used for debugging purposes.
x-apideck-app-id String Yes The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
Authorization String Yes Bearer API KEY

Authorization

You can interact with the API through the authorization methods below.

apiKey

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>

You should use the public keys on the SDKs and the secret keys to authenticate API requests.

Do not share or include your secret API keys on client side code. Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.

Learn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key

Go to Unify to grab your API KEY https://app.apideck.com/unify/api-keys

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

applicationId

The ID of your Unify application

Security Scheme Type API Key
Header parameter name x-apideck-app-id

consumerId

The ID of the consumer which you want to get or push data from

Security Scheme Type API Key
Header parameter name x-apideck-consumer-id

Pagination

All API resources have support for bulk retrieval via list APIs. For example, you can list opportunities, companies and leads. Apideck uses cursor-based pagination via the optional cursor and limit parameters.

To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.

In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.

Query Parameters

Name Type Required Description
cursor String No Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limit Number No Number of results to return. Minimum 1, Maximum 200, Default 20

Response Body

Name Type Description
meta.cursors.previous String Cursor to navigate to the previous page of results through the API
meta.cursors.current String Cursor to navigate to the current page of results through the API
meta.cursors.next String Cursor to navigate to the next page of results through the API
meta.items_on_page Number Number of items returned in the data property of the response
links.previous String Link to navigate to the previous page of results through the API
links.current String Link to navigate to the current page of results through the API
links.next String Link to navigate to the next page of results through the API

⚠️ meta.cursors.previous/links.previous is not available for all connectors.

SDKs and API Clients

Debugging

Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.

Errors

The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.

Code Title Description
200 OK The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.
201 Created The request has been fulfilled and has resulted in one or more new resources being created.
204 No Content The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.
400 Bad Request The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request.
401 Unauthorized The request has not been applied because it lacks valid authentication credentials for the target resource.
402 Payment Required Subscription data is incomplete or out of date. You'll need to provide payment details to continue.
403 Forbidden You do not have the appropriate user rights to access the request. Do not repeat the request.
404 Not Found The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
409 Conflict The request could not be completed due to a conflict with the current state of the target resource.
422 Unprocessable Entity The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.
5xx Server Errors Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.

Handling errors

The Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.

Error Types

RequestBodyValidationError

Request body is not valid for the current endpoint. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.

RequestParametersValidationError

Request parameters are not valid for the current endpoint. Check the spelling and types of your parameters, and ensure you are not passing parameters that are outside of the specification.

RequestHeadersValidationError

Request headers are not valid for the current endpoint. Check the spelling and types of your headers, and ensure you are not passing headers that are outside of the specification.

UnsupportedFiltersError

Filters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.

UnsupportedSortFieldError

Sort field (sort[by]) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.

InvalidCursorError

Pagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.

ConnectorExecutionError

A Unified API request made via one of our downstream connectors returned an unexpected error. The status_code returned is proxied through to error response along with their original response via the error detail.

ConnectorProcessingError

A Unified API request made via one of our downstream connectors returned a status code that was less than 400, along with a description of why the request could not be processed. Often this is due to the shape of request data being valid, but unable to be processed due to internal business logic - for example: an invalid relationship or ID present in your request.

UnauthorizedError

We were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: Authorization: 'Bearer sk_live_***'

ConnectorCredentialsError

A request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.

ConnectorDisabledError

A request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.

RequestLimitError

You have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately.

EntityNotFoundError

You've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.

OAuthCredentialsNotFoundError

When adding a connector integration that implements OAuth, both a client_id and client_secret must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.

IntegrationNotFoundError

The requested connector integration could not be found associated to your application_id. Verify your application_id is correct, and that this connector has been added and configured for your application.

ConnectionNotFoundError

A valid connection could not be found associated to your application_id. Something may have interrupted the authorization flow. You may need to start the connector authorization process again.

ConnectorNotFoundError

A request was made for an unknown connector. Verify your service_id is spelled correctly, and that this connector is enabled for your provided unified_api.

OAuthRedirectUriError

A request was made either in a connector authorization flow, or attempting to revoke connector access without a valid redirect_uri. This is the url the user should be returned to on completion of process.

OAuthInvalidStateError

The state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.

OAuthCodeExchangeError

When attempting to exchange the authorization code for an access_token during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.

MappingError

There was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.

ConnectorMappingNotFoundError

It seems the implementation for this connector is incomplete. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorResponseMappingNotFoundError

We were unable to retrieve the response mapping for this connector. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorOperationMappingNotFoundError

Connector mapping has not been implemented for the requested operation. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

ConnectorWorkflowMappingError

The composite api calls required for this operation have not been mapped entirely. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

PaginationNotSupportedError

Pagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in beta or still under development. We've been notified and are working to fix this issue.

API Design

API Styles and data formats

REST API

The API is organized around REST, providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.

Available HTTP methods

The Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter _method.

POST /messages
GET /messages
GET /messages/{messageId}
PATCH /messages/{messageId}
DELETE /messages/{messageId}

Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.

Schema

All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.

Meta

Meta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.

Idempotence (upcoming)

To prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once.

Uniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.)

Request IDs

Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.

Fixed field types

Dates

The dates returned by the API are all represented in UTC (ISO8601 format).

This example 2019-11-14T00:55:31.820Z is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced "Zulu" per military/aviation tradition.

The ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.

Prices and Currencies

All prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents).

For zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5.

All currency codes conform to ISO 4217.

Support

If you have problems or need help with your case, you can always reach out to our Support.

Companies

The Company model

idstring
namestringnon-empty
required
interaction_countinteger
Nullable
owner_idstring
image_urlstring
Nullable
descriptionstring
Nullable

Company example

{}

List companies

get/crm/companies

List companies

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

filterobjectfilter[name]=SpaceX

Apply filters (beta)

sortobjectsort[by]=created_at

Apply sorting (beta)

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Companies
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "name": "Copper",
      "interaction_count": 1,
      "owner_id": "12345",
      "image_url": "https://www.spacex.com/static/images/share.jpg",
      "description": "A crm that works for you, so you can spend time on relationships instead of data.",
      "vat_number": "BE0689615164",
      "currency": "USD",
      "status": "Open",
      "fax": "+12129876543",
      "bank_accounts": [
        {
          "iban": "CH2989144532982975332",
          "bic": "AUDSCHGGXXX"
        }
      ],
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638"
        }
      ],
      "social_links": [
        {
          "id": "12345",
          "url": "https://www.twitter.com/apideck-io",
          "type": "twitter"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "number": "111-111-1111",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "custom_fields": [
        {
          "id": "custom_technologies",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "tags": [
        "New"
      ],
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create company

post/crm/companies

Create company

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
owner_idstring
bank_accountsobjects
websitesobjects
addressesobjects
social_linksobjects
phone_numbersobjects
emailsobjects
custom_fieldsobjects
tagsstrings
image_urlstring
Nullable
descriptionstring
Nullable
vat_numberstring
Nullable

VAT number

currencystring
Nullable
statusstringnon-empty
Nullable
faxstring
Nullable

Responses

201Company created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "name": "Copper",
  "owner_id": "12345",
  "image_url": "https://www.spacex.com/static/images/share.jpg",
  "description": "A crm that works for you, so you can spend time on relationships instead of data.",
  "vat_number": "BE0689615164",
  "currency": "USD",
  "status": "Open",
  "fax": "+12129876543",
  "bank_accounts": [
    {
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck-io",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "111-111-1111",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get company

get/crm/companies/{id}

Get company

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Company
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Copper",
    "interaction_count": 1,
    "owner_id": "12345",
    "image_url": "https://www.spacex.com/static/images/share.jpg",
    "description": "A crm that works for you, so you can spend time on relationships instead of data.",
    "vat_number": "BE0689615164",
    "currency": "USD",
    "status": "Open",
    "fax": "+12129876543",
    "bank_accounts": [
      {
        "iban": "CH2989144532982975332",
        "bic": "AUDSCHGGXXX"
      }
    ],
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638"
      }
    ],
    "social_links": [
      {
        "id": "12345",
        "url": "https://www.twitter.com/apideck-io",
        "type": "twitter"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "number": "111-111-1111",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "custom_fields": [
      {
        "id": "custom_technologies",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "tags": [
      "New"
    ],
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update company

patch/crm/companies/{id}

Update company

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
owner_idstring
bank_accountsobjects
websitesobjects
addressesobjects
social_linksobjects
phone_numbersobjects
emailsobjects
custom_fieldsobjects
tagsstrings
image_urlstring
Nullable
descriptionstring
Nullable
vat_numberstring
Nullable

VAT number

currencystring
Nullable
statusstringnon-empty
Nullable
faxstring
Nullable

Responses

200Company updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "name": "Copper",
  "owner_id": "12345",
  "image_url": "https://www.spacex.com/static/images/share.jpg",
  "description": "A crm that works for you, so you can spend time on relationships instead of data.",
  "vat_number": "BE0689615164",
  "currency": "USD",
  "status": "Open",
  "fax": "+12129876543",
  "bank_accounts": [
    {
      "iban": "CH2989144532982975332",
      "bic": "AUDSCHGGXXX"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck-io",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "111-111-1111",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete company

delete/crm/companies/{id}

Delete company

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Company deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Opportunities

The Opportunity model

idstring
titlestringnon-empty
required
primary_contact_idstring
required
Nullable
descriptionstringnon-empty
Nullable
monetary_amountnumber
Nullable
currencystring
Nullable

Opportunity example

{}

List opportunities

get/crm/opportunities

List opportunities

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

filterobjectfilter[title]=Tesla deal

Apply filters (beta)

sortobjectsort[by]=created_at

Apply sorting (beta)

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Opportunities
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "opportunities",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "title": "New Rocket",
      "primary_contact_id": "12345",
      "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
      "monetary_amount": 75000,
      "currency": "USD",
      "win_probability": 40,
      "close_date": "2020-10-30",
      "loss_reason_id": "12345",
      "loss_reason": "No budget",
      "won_reason_id": "12345",
      "won_reason": "Best pitch",
      "pipeline_id": "12345",
      "pipeline_stage_id": "12345",
      "source_id": "12345",
      "lead_id": "12345",
      "contact_id": "12345",
      "company_id": "12345",
      "company_name": "Copper",
      "owner_id": "12345",
      "priority": "None",
      "status": "Open",
      "status_id": "12345",
      "tags": [
        "New"
      ],
      "interaction_count": 0,
      "custom_fields": [
        {
          "id": "custom_technologies",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "date_stage_changed": "2020-09-30T00:00:00.000Z",
      "date_last_contacted": "2020-09-30T00:00:00.000Z",
      "date_lead_created": "2020-09-30T00:00:00.000Z",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create opportunity

post/crm/opportunities

Create opportunity

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
titlestringnon-empty
required
primary_contact_idstring
required
Nullable
tagsstrings
custom_fieldsobjects
descriptionstringnon-empty
Nullable
monetary_amountnumber
Nullable
currencystring
Nullable
win_probabilitynumber
Nullable
close_datestring
Nullable
loss_reason_idstring
Nullable
loss_reasonstring
Nullable
won_reason_idstring
Nullable
won_reasonstring
Nullable
pipeline_idstring
Nullable
pipeline_stage_idstring
Nullable
source_idstring
Nullable
lead_idstring
Nullable
contact_idstring
Nullable
company_idstring
Nullable
company_namestring
Nullable
owner_idstring
Nullable
prioritystringnon-empty
Nullable
statusstringnon-empty
Nullable
status_idstring
Nullable

Responses

201Opportunity
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "title": "New Rocket",
  "primary_contact_id": "12345",
  "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
  "monetary_amount": 75000,
  "currency": "USD",
  "win_probability": 40,
  "close_date": "2020-10-30",
  "loss_reason_id": "12345",
  "loss_reason": "No budget",
  "won_reason_id": "12345",
  "won_reason": "Best pitch",
  "pipeline_id": "12345",
  "pipeline_stage_id": "12345",
  "source_id": "12345",
  "lead_id": "12345",
  "contact_id": "12345",
  "company_id": "12345",
  "company_name": "Copper",
  "owner_id": "12345",
  "priority": "None",
  "status": "Open",
  "status_id": "12345",
  "tags": [
    "New"
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "opportunities",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get opportunity

get/crm/opportunities/{id}

Get opportunity

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Opportunity
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "opportunities",
  "operation": "one",
  "data": {
    "id": "12345",
    "title": "New Rocket",
    "primary_contact_id": "12345",
    "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
    "monetary_amount": 75000,
    "currency": "USD",
    "win_probability": 40,
    "close_date": "2020-10-30",
    "loss_reason_id": "12345",
    "loss_reason": "No budget",
    "won_reason_id": "12345",
    "won_reason": "Best pitch",
    "pipeline_id": "12345",
    "pipeline_stage_id": "12345",
    "source_id": "12345",
    "lead_id": "12345",
    "contact_id": "12345",
    "company_id": "12345",
    "company_name": "Copper",
    "owner_id": "12345",
    "priority": "None",
    "status": "Open",
    "status_id": "12345",
    "tags": [
      "New"
    ],
    "interaction_count": 0,
    "custom_fields": [
      {
        "id": "custom_technologies",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "date_stage_changed": "2020-09-30T00:00:00.000Z",
    "date_last_contacted": "2020-09-30T00:00:00.000Z",
    "date_lead_created": "2020-09-30T00:00:00.000Z",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update opportunity

patch/crm/opportunities/{id}

Update opportunity

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
titlestringnon-empty
required
primary_contact_idstring
required
Nullable
tagsstrings
custom_fieldsobjects
descriptionstringnon-empty
Nullable
monetary_amountnumber
Nullable
currencystring
Nullable
win_probabilitynumber
Nullable
close_datestring
Nullable
loss_reason_idstring
Nullable
loss_reasonstring
Nullable
won_reason_idstring
Nullable
won_reasonstring
Nullable
pipeline_idstring
Nullable
pipeline_stage_idstring
Nullable
source_idstring
Nullable
lead_idstring
Nullable
contact_idstring
Nullable
company_idstring
Nullable
company_namestring
Nullable
owner_idstring
Nullable
prioritystringnon-empty
Nullable
statusstringnon-empty
Nullable
status_idstring
Nullable

Responses

200Opportunity updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "title": "New Rocket",
  "primary_contact_id": "12345",
  "description": "Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.",
  "monetary_amount": 75000,
  "currency": "USD",
  "win_probability": 40,
  "close_date": "2020-10-30",
  "loss_reason_id": "12345",
  "loss_reason": "No budget",
  "won_reason_id": "12345",
  "won_reason": "Best pitch",
  "pipeline_id": "12345",
  "pipeline_stage_id": "12345",
  "source_id": "12345",
  "lead_id": "12345",
  "contact_id": "12345",
  "company_id": "12345",
  "company_name": "Copper",
  "owner_id": "12345",
  "priority": "None",
  "status": "Open",
  "status_id": "12345",
  "tags": [
    "New"
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete opportunity

delete/crm/opportunities/{id}

Delete opportunity

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Opportunity deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Leads

The Lead model

idstring
namestringnon-empty
required
company_namestring
required
Nullable
owner_idstring
company_idstring
Nullable
contact_idstring
Nullable

Lead example

{}

List leads

get/crm/leads

List leads

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

filterobjectfilter[name]=Elon Musk

Apply filters (beta)

sortobjectsort[by]=created_at

Apply sorting (beta)

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Leads
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "name": "Elon Musk",
      "company_name": "Spacex",
      "owner_id": "54321",
      "company_id": "2",
      "contact_id": "2",
      "lead_source": "Cold Call",
      "first_name": "Elon",
      "last_name": "Musk",
      "description": "A thinker",
      "prefix": "Sir",
      "title": "CEO",
      "language": "EN",
      "status": "New",
      "monetary_amount": 75000,
      "currency": "USD",
      "fax": "+12129876543",
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638"
        }
      ],
      "social_links": [
        {
          "id": "12345",
          "url": "https://www.twitter.com/apideck-io",
          "type": "twitter"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "number": "111-111-1111",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "custom_fields": [
        {
          "id": "custom_technologies",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "tags": [
        "New"
      ],
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create lead

post/crm/leads

Create lead

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
company_namestring
required
Nullable
owner_idstring
websitesobjects
addressesobjects
social_linksobjects
phone_numbersobjects
emailsobjects
custom_fieldsobjects
tagsstrings
company_idstring
Nullable
contact_idstring
Nullable
lead_sourcestring
Nullable
first_namestring
Nullable
last_namestring
Nullable
descriptionstring
Nullable
prefixstring
Nullable
titlestring
Nullable
languagestring
Nullable

language code according to ISO 639-1. For the United States - EN

statusstring
Nullable
monetary_amountnumber
Nullable
currencystring
Nullable
faxstring
Nullable

Responses

201Lead created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "name": "Elon Musk",
  "company_name": "Spacex",
  "owner_id": "54321",
  "company_id": "2",
  "contact_id": "2",
  "lead_source": "Cold Call",
  "first_name": "Elon",
  "last_name": "Musk",
  "description": "A thinker",
  "prefix": "Sir",
  "title": "CEO",
  "language": "EN",
  "status": "New",
  "monetary_amount": 75000,
  "currency": "USD",
  "fax": "+12129876543",
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck-io",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "111-111-1111",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get lead

get/crm/leads/{id}

Get lead

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Lead
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Elon Musk",
    "company_name": "Spacex",
    "owner_id": "54321",
    "company_id": "2",
    "contact_id": "2",
    "lead_source": "Cold Call",
    "first_name": "Elon",
    "last_name": "Musk",
    "description": "A thinker",
    "prefix": "Sir",
    "title": "CEO",
    "language": "EN",
    "status": "New",
    "monetary_amount": 75000,
    "currency": "USD",
    "fax": "+12129876543",
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638"
      }
    ],
    "social_links": [
      {
        "id": "12345",
        "url": "https://www.twitter.com/apideck-io",
        "type": "twitter"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "number": "111-111-1111",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "custom_fields": [
      {
        "id": "custom_technologies",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "tags": [
      "New"
    ],
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update lead

patch/crm/leads/{id}

Update lead

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
company_namestring
required
Nullable
owner_idstring
websitesobjects
addressesobjects
social_linksobjects
phone_numbersobjects
emailsobjects
custom_fieldsobjects
tagsstrings
company_idstring
Nullable
contact_idstring
Nullable
lead_sourcestring
Nullable
first_namestring
Nullable
last_namestring
Nullable
descriptionstring
Nullable
prefixstring
Nullable
titlestring
Nullable
languagestring
Nullable

language code according to ISO 639-1. For the United States - EN

statusstring
Nullable
monetary_amountnumber
Nullable
currencystring
Nullable
faxstring
Nullable

Responses

200Lead updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "name": "Elon Musk",
  "company_name": "Spacex",
  "owner_id": "54321",
  "company_id": "2",
  "contact_id": "2",
  "lead_source": "Cold Call",
  "first_name": "Elon",
  "last_name": "Musk",
  "description": "A thinker",
  "prefix": "Sir",
  "title": "CEO",
  "language": "EN",
  "status": "New",
  "monetary_amount": 75000,
  "currency": "USD",
  "fax": "+12129876543",
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck-io",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "111-111-1111",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete lead

delete/crm/leads/{id}

Delete lead

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Lead deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Contacts

The Contact model

idstring
namestringnon-empty
required
owner_idstring
Nullable
company_idstring
Nullable
company_namestring
Nullable
lead_idstring
Nullable

Contact example

{}

List contacts

get/crm/contacts

List contacts

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

filterobjectfilter[name]=Elon Musk

Apply filters (beta)

sortobjectsort[by]=created_at

Apply sorting (beta)

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Contacts
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "name": "Elon Musk",
      "owner_id": "54321",
      "company_id": "23456",
      "company_name": "23456",
      "lead_id": "34567",
      "first_name": "Elon",
      "middle_name": "D.",
      "last_name": "Musk",
      "prefix": "Mr.",
      "suffix": "PhD",
      "title": "CEO",
      "department": "Engineering",
      "language": "EN",
      "gender": "female",
      "birthday": "2000-08-12",
      "image": "https://logo.clearbit.com/spacex.com?s=128",
      "lead_source": "Cold Call",
      "fax": "+12129876543",
      "description": "Internal champion",
      "status": "open",
      "websites": [
        {
          "id": "12345",
          "url": "http://example.com",
          "type": "primary"
        }
      ],
      "addresses": [
        {
          "id": "123",
          "type": "primary",
          "name": "HQ US",
          "line1": "Main street",
          "line2": "apt #",
          "city": "San Francisco",
          "state": "CA",
          "postal_code": "94104",
          "country": "US",
          "latitude": "40.759211",
          "longitude": "-73.984638"
        }
      ],
      "social_links": [
        {
          "id": "12345",
          "url": "https://www.twitter.com/apideck-io",
          "type": "twitter"
        }
      ],
      "phone_numbers": [
        {
          "id": "12345",
          "number": "111-111-1111",
          "type": "primary"
        }
      ],
      "emails": [
        {
          "id": "123",
          "email": "elon@musk.com",
          "type": "primary"
        }
      ],
      "custom_fields": [
        {
          "id": "custom_technologies",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "tags": [
        "New"
      ],
      "updated_at": "2017-08-12T20:43:21.291Z",
      "created_at": "2017-08-12T20:43:21.291Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create contact

post/crm/contacts

Create contact

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
websitesobjects
addressesobjects
social_linksobjects
phone_numbersobjects
emailsobjects
custom_fieldsobjects
tagsstrings
owner_idstring
Nullable
company_idstring
Nullable
company_namestring
Nullable
lead_idstring
Nullable
first_namestring
Nullable
middle_namestring
Nullable
last_namestring
Nullable
prefixstring
Nullable
suffixstring
Nullable
titlestring
Nullable
departmentstring
Nullable
languagestring
Nullable

language code according to ISO 639-1. For the United States - EN

genderstring
Nullable
Enum:malefemaleunisex
birthdaystring
Nullable
imagestring
Nullable
lead_sourcestringnon-empty
Nullable
faxstring
Nullable
descriptionstring
Nullable
statusstring
Nullable

Responses

201Contact created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "name": "Elon Musk",
  "owner_id": "54321",
  "company_id": "23456",
  "company_name": "23456",
  "lead_id": "34567",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "prefix": "Mr.",
  "suffix": "PhD",
  "title": "CEO",
  "department": "Engineering",
  "language": "EN",
  "gender": "female",
  "birthday": "2000-08-12",
  "image": "https://logo.clearbit.com/spacex.com?s=128",
  "lead_source": "Cold Call",
  "fax": "+12129876543",
  "description": "Internal champion",
  "status": "open",
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck-io",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "111-111-1111",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get contact

get/crm/contacts/{id}

Get contact

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Contact
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "name": "Elon Musk",
    "owner_id": "54321",
    "company_id": "23456",
    "company_name": "23456",
    "lead_id": "34567",
    "first_name": "Elon",
    "middle_name": "D.",
    "last_name": "Musk",
    "prefix": "Mr.",
    "suffix": "PhD",
    "title": "CEO",
    "department": "Engineering",
    "language": "EN",
    "gender": "female",
    "birthday": "2000-08-12",
    "image": "https://logo.clearbit.com/spacex.com?s=128",
    "lead_source": "Cold Call",
    "fax": "+12129876543",
    "description": "Internal champion",
    "status": "open",
    "websites": [
      {
        "id": "12345",
        "url": "http://example.com",
        "type": "primary"
      }
    ],
    "addresses": [
      {
        "id": "123",
        "type": "primary",
        "name": "HQ US",
        "line1": "Main street",
        "line2": "apt #",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94104",
        "country": "US",
        "latitude": "40.759211",
        "longitude": "-73.984638"
      }
    ],
    "social_links": [
      {
        "id": "12345",
        "url": "https://www.twitter.com/apideck-io",
        "type": "twitter"
      }
    ],
    "phone_numbers": [
      {
        "id": "12345",
        "number": "111-111-1111",
        "type": "primary"
      }
    ],
    "emails": [
      {
        "id": "123",
        "email": "elon@musk.com",
        "type": "primary"
      }
    ],
    "custom_fields": [
      {
        "id": "custom_technologies",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "tags": [
      "New"
    ],
    "updated_at": "2017-08-12T20:43:21.291Z",
    "created_at": "2017-08-12T20:43:21.291Z"
  }
}

Update contact

patch/crm/contacts/{id}

Update contact

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
websitesobjects
addressesobjects
social_linksobjects
phone_numbersobjects
emailsobjects
custom_fieldsobjects
tagsstrings
owner_idstring
Nullable
company_idstring
Nullable
company_namestring
Nullable
lead_idstring
Nullable
first_namestring
Nullable
middle_namestring
Nullable
last_namestring
Nullable
prefixstring
Nullable
suffixstring
Nullable
titlestring
Nullable
departmentstring
Nullable
languagestring
Nullable

language code according to ISO 639-1. For the United States - EN

genderstring
Nullable
Enum:malefemaleunisex
birthdaystring
Nullable
imagestring
Nullable
lead_sourcestringnon-empty
Nullable
faxstring
Nullable
descriptionstring
Nullable
statusstring
Nullable

Responses

200Contact updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "name": "Elon Musk",
  "owner_id": "54321",
  "company_id": "23456",
  "company_name": "23456",
  "lead_id": "34567",
  "first_name": "Elon",
  "middle_name": "D.",
  "last_name": "Musk",
  "prefix": "Mr.",
  "suffix": "PhD",
  "title": "CEO",
  "department": "Engineering",
  "language": "EN",
  "gender": "female",
  "birthday": "2000-08-12",
  "image": "https://logo.clearbit.com/spacex.com?s=128",
  "lead_source": "Cold Call",
  "fax": "+12129876543",
  "description": "Internal champion",
  "status": "open",
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck-io",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "number": "111-111-1111",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete contact

delete/crm/contacts/{id}

Delete contact

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Contact deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Pipelines

The Pipeline model

idstring
namestringnon-empty
required
currencystring
archivedboolean
display_orderinteger
stagesobjects

Pipeline example

{}

List pipelines

get/crm/pipelines

List pipelines

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Pipelines
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "pipelines",
  "operation": "one",
  "data": [
    {
      "id": "default",
      "name": "Sales Pipeline",
      "currency": "USD",
      "archived": false,
      "display_order": 1,
      "stages": [
        {
          "id": "contractsent",
          "name": "Contract Sent",
          "value": "CONTRACT_SENT",
          "display_order": 1
        }
      ],
      "updated_at": "2017-08-12T20:43:21.291Z",
      "created_at": "2017-08-12T20:43:21.291Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create pipeline

post/crm/pipelines

Create pipeline

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
idstring
currencystring
archivedboolean
display_orderinteger
stagesobjects

Responses

201Pipeline created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "id": "default",
  "name": "Sales Pipeline",
  "currency": "USD",
  "archived": false,
  "display_order": 1,
  "stages": [
    {
      "name": "Contract Sent",
      "value": "CONTRACT_SENT",
      "display_order": 1
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "pipelines",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get pipeline

get/crm/pipelines/{id}

Get pipeline

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Pipeline
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "pipelines",
  "operation": "one",
  "data": {
    "id": "default",
    "name": "Sales Pipeline",
    "currency": "USD",
    "archived": false,
    "display_order": 1,
    "stages": [
      {
        "id": "contractsent",
        "name": "Contract Sent",
        "value": "CONTRACT_SENT",
        "display_order": 1
      }
    ],
    "updated_at": "2017-08-12T20:43:21.291Z",
    "created_at": "2017-08-12T20:43:21.291Z"
  }
}

Update pipeline

patch/crm/pipelines/{id}

Update pipeline

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
namestringnon-empty
required
idstring
currencystring
archivedboolean
display_orderinteger
stagesobjects

Responses

200Pipeline updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "id": "default",
  "name": "Sales Pipeline",
  "currency": "USD",
  "archived": false,
  "display_order": 1,
  "stages": [
    {
      "name": "Contract Sent",
      "value": "CONTRACT_SENT",
      "display_order": 1
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "pipelines",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete pipeline

delete/crm/pipelines/{id}

Delete pipeline

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Pipeline deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Notes

The Note model

idstring
titlestring
contentstring
owner_idstring
updated_bystring
Nullable
created_bystring
Nullable

Note example

{}

List notes

get/crm/notes

List notes

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Notes
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "notes",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "title": "Meeting Notes",
      "content": "Office hours are 9AM-6PM",
      "owner_id": "12345",
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create note

post/crm/notes

Create note

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
titlestring
contentstring
owner_idstring

Responses

201Note
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "title": "Meeting Notes",
  "content": "Office hours are 9AM-6PM",
  "owner_id": "12345"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "notes",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get note

get/crm/notes/{id}

Get note

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Note
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "notes",
  "operation": "one",
  "data": {
    "id": "12345",
    "title": "Meeting Notes",
    "content": "Office hours are 9AM-6PM",
    "owner_id": "12345",
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update note

patch/crm/notes/{id}

Update note

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
titlestring
contentstring
owner_idstring

Responses

200Note
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "title": "Meeting Notes",
  "content": "Office hours are 9AM-6PM",
  "owner_id": "12345"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "notes",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete note

delete/crm/notes/{id}

Delete note

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Note
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "notes",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Users

The User model

idstring
emailstringnon-empty
required
parent_idstring
Nullable
usernamestring
Nullable
first_namestring
Nullable
last_namestring
Nullable

User example

{}

List users

get/crm/users

List users

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Users
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "users",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "email": "elon@musk.com",
      "parent_id": "54321",
      "username": "masterofcoin",
      "first_name": "Elon",
      "last_name": "Musk",
      "image": "https://logo.clearbit.com/spacex.com?s=128",
      "language": "EN",
      "status": "active",
      "updated_at": "2017-08-12T20:43:21.291Z",
      "created_at": "2017-08-12T20:43:21.291Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create user

post/crm/users

Create user

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
emailstringnon-empty
required
passwordstring
parent_idstring
Nullable
usernamestring
Nullable
first_namestring
Nullable
last_namestring
Nullable
imagestring
Nullable
languagestring
Nullable
statusstring
Nullable

Responses

201User created
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "email": "elon@musk.com",
  "parent_id": "54321",
  "username": "masterofcoin",
  "first_name": "Elon",
  "last_name": "Musk",
  "image": "https://logo.clearbit.com/spacex.com?s=128",
  "language": "EN",
  "status": "active",
  "password": "supersecretpassword"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "users",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get user

get/crm/users/{id}

Get user

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200User
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345",
    "email": "elon@musk.com",
    "parent_id": "54321",
    "username": "masterofcoin",
    "first_name": "Elon",
    "last_name": "Musk",
    "image": "https://logo.clearbit.com/spacex.com?s=128",
    "language": "EN",
    "status": "active",
    "updated_at": "2017-08-12T20:43:21.291Z",
    "created_at": "2017-08-12T20:43:21.291Z"
  }
}

Update user

patch/crm/users/{id}

Update user

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
emailstringnon-empty
required
passwordstring
parent_idstring
Nullable
usernamestring
Nullable
first_namestring
Nullable
last_namestring
Nullable
imagestring
Nullable
languagestring
Nullable
statusstring
Nullable

Responses

200User updated
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "email": "elon@musk.com",
  "parent_id": "54321",
  "username": "masterofcoin",
  "first_name": "Elon",
  "last_name": "Musk",
  "image": "https://logo.clearbit.com/spacex.com?s=128",
  "language": "EN",
  "status": "active",
  "password": "supersecretpassword"
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete user

delete/crm/users/{id}

Delete user

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200User deleted
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "users",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Activities

The Activity model

idstring
activity_datetimestringnon-empty
Nullable
duration_secondsinteger>= 0
Nullable
account_idstring
Nullable
contact_idstring
Nullable
company_idstring
Nullable

Activity example

{}

List activities

get/crm/activities

List activities

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

limitinteger[ 1 .. 200 ]
Default:20

Number of records to return

cursorstring
Nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

Responses

200Activities
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "activities",
  "operation": "one",
  "data": [
    {
      "id": "12345",
      "activity_datetime": "2021-05-01T12:00:00.000Z",
      "duration_seconds": 1800,
      "account_id": "12345",
      "contact_id": "12345",
      "company_id": "12345",
      "opportunity_id": "12345",
      "lead_id": "12345",
      "owner_id": "12345",
      "campaign_id": "12345",
      "case_id": "12345",
      "asset_id": "12345",
      "contract_id": "12345",
      "product_id": "12345",
      "solution_id": "12345",
      "custom_object_id": "12345",
      "type": "meeting",
      "title": "Meeting",
      "description": "More info about the meeting",
      "location": "Space",
      "all_day_event": false,
      "private": true,
      "group_event": true,
      "event_sub_type": "debrief",
      "group_event_type": "Proposed",
      "child": false,
      "archived": false,
      "deleted": false,
      "show_as": "busy",
      "activity_date": "2021-05-01",
      "duration_minutes": 30,
      "start_datetime": "2021-05-01T12:00:00.000Z",
      "end_datetime": "2021-05-01T12:30:00.000Z",
      "end_date": "2021-05-01",
      "recurrent": false,
      "reminder_datetime": "2021-05-01T17:00:00.000Z",
      "reminder_set": false,
      "custom_fields": [
        {
          "id": "custom_technologies",
          "value": "Uses Salesforce and Marketo"
        }
      ],
      "updated_by": "12345",
      "created_by": "12345",
      "updated_at": "2020-09-30T07:43:32.000Z",
      "created_at": "2020-09-30T07:43:32.000Z"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    }
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}

Create activity

post/crm/activities

Create activity

Authorizations:

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
typestring
required
Enum:callmeetingemailnotetasksend-lettersend-quoteother
all_day_eventboolean
privateboolean
group_eventboolean
childboolean
archivedboolean
deletedboolean
show_asstring
Enum:freebusy
recurrentboolean
custom_fieldsobjects
activity_datetimestringnon-empty
Nullable
duration_secondsinteger>= 0
Nullable
account_idstring
Nullable
contact_idstring
Nullable
company_idstring
Nullable
opportunity_idstring
Nullable
lead_idstring
Nullable
owner_idstring
Nullable
campaign_idstring
Nullable
case_idstring
Nullable
asset_idstring
Nullable
contract_idstring
Nullable
product_idstring
Nullable
solution_idstring
Nullable
custom_object_idstring
Nullable
titlestring
Nullable
descriptionstring
Nullable
locationstring
Nullable
event_sub_typestring
Nullable
group_event_typestring
Nullable
activity_datestring
Nullable
duration_minutesinteger
Nullable
start_datetimestring
Nullable
end_datetimestring
Nullable
end_datestring
Nullable
reminder_datetimestring
Nullable
reminder_setboolean
Nullable

Responses

201Activity
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "activity_datetime": "2021-05-01T12:00:00.000Z",
  "duration_seconds": 1800,
  "account_id": "12345",
  "contact_id": "12345",
  "company_id": "12345",
  "opportunity_id": "12345",
  "lead_id": "12345",
  "owner_id": "12345",
  "campaign_id": "12345",
  "case_id": "12345",
  "asset_id": "12345",
  "contract_id": "12345",
  "product_id": "12345",
  "solution_id": "12345",
  "custom_object_id": "12345",
  "type": "meeting",
  "title": "Meeting",
  "description": "More info about the meeting",
  "location": "Space",
  "all_day_event": false,
  "private": true,
  "group_event": true,
  "event_sub_type": "debrief",
  "group_event_type": "Proposed",
  "child": false,
  "archived": false,
  "deleted": false,
  "show_as": "busy",
  "activity_date": "2021-05-01",
  "duration_minutes": 30,
  "start_datetime": "2021-05-01T12:00:00.000Z",
  "end_datetime": "2021-05-01T12:30:00.000Z",
  "end_date": "2021-05-01",
  "recurrent": false,
  "reminder_datetime": "2021-05-01T17:00:00.000Z",
  "reminder_set": false,
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "activities",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Get activity

get/crm/activities/{id}

Get activity

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Activity
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "activities",
  "operation": "one",
  "data": {
    "id": "12345",
    "activity_datetime": "2021-05-01T12:00:00.000Z",
    "duration_seconds": 1800,
    "account_id": "12345",
    "contact_id": "12345",
    "company_id": "12345",
    "opportunity_id": "12345",
    "lead_id": "12345",
    "owner_id": "12345",
    "campaign_id": "12345",
    "case_id": "12345",
    "asset_id": "12345",
    "contract_id": "12345",
    "product_id": "12345",
    "solution_id": "12345",
    "custom_object_id": "12345",
    "type": "meeting",
    "title": "Meeting",
    "description": "More info about the meeting",
    "location": "Space",
    "all_day_event": false,
    "private": true,
    "group_event": true,
    "event_sub_type": "debrief",
    "group_event_type": "Proposed",
    "child": false,
    "archived": false,
    "deleted": false,
    "show_as": "busy",
    "activity_date": "2021-05-01",
    "duration_minutes": 30,
    "start_datetime": "2021-05-01T12:00:00.000Z",
    "end_datetime": "2021-05-01T12:30:00.000Z",
    "end_date": "2021-05-01",
    "recurrent": false,
    "reminder_datetime": "2021-05-01T17:00:00.000Z",
    "reminder_set": false,
    "custom_fields": [
      {
        "id": "custom_technologies",
        "value": "Uses Salesforce and Marketo"
      }
    ],
    "updated_by": "12345",
    "created_by": "12345",
    "updated_at": "2020-09-30T07:43:32.000Z",
    "created_at": "2020-09-30T07:43:32.000Z"
  }
}

Update activity

patch/crm/activities/{id}

Update activity

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Request body schema

application/json
typestring
required
Enum:callmeetingemailnotetasksend-lettersend-quoteother
all_day_eventboolean
privateboolean
group_eventboolean
childboolean
archivedboolean
deletedboolean
show_asstring
Enum:freebusy
recurrentboolean
custom_fieldsobjects
activity_datetimestringnon-empty
Nullable
duration_secondsinteger>= 0
Nullable
account_idstring
Nullable
contact_idstring
Nullable
company_idstring
Nullable
opportunity_idstring
Nullable
lead_idstring
Nullable
owner_idstring
Nullable
campaign_idstring
Nullable
case_idstring
Nullable
asset_idstring
Nullable
contract_idstring
Nullable
product_idstring
Nullable
solution_idstring
Nullable
custom_object_idstring
Nullable
titlestring
Nullable
descriptionstring
Nullable
locationstring
Nullable
event_sub_typestring
Nullable
group_event_typestring
Nullable
activity_datestring
Nullable
duration_minutesinteger
Nullable
start_datetimestring
Nullable
end_datetimestring
Nullable
end_datestring
Nullable
reminder_datetimestring
Nullable
reminder_setboolean
Nullable

Responses

200Activity
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Request example

Payload

{
  "activity_datetime": "2021-05-01T12:00:00.000Z",
  "duration_seconds": 1800,
  "account_id": "12345",
  "contact_id": "12345",
  "company_id": "12345",
  "opportunity_id": "12345",
  "lead_id": "12345",
  "owner_id": "12345",
  "campaign_id": "12345",
  "case_id": "12345",
  "asset_id": "12345",
  "contract_id": "12345",
  "product_id": "12345",
  "solution_id": "12345",
  "custom_object_id": "12345",
  "type": "meeting",
  "title": "Meeting",
  "description": "More info about the meeting",
  "location": "Space",
  "all_day_event": false,
  "private": true,
  "group_event": true,
  "event_sub_type": "debrief",
  "group_event_type": "Proposed",
  "child": false,
  "archived": false,
  "deleted": false,
  "show_as": "busy",
  "activity_date": "2021-05-01",
  "duration_minutes": 30,
  "start_datetime": "2021-05-01T12:00:00.000Z",
  "end_datetime": "2021-05-01T12:30:00.000Z",
  "end_date": "2021-05-01",
  "recurrent": false,
  "reminder_datetime": "2021-05-01T17:00:00.000Z",
  "reminder_set": false,
  "custom_fields": [
    {
      "id": "custom_technologies",
      "value": "Uses Salesforce and Marketo"
    }
  ]
}

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "activities",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}

Delete activity

delete/crm/activities/{id}

Delete activity

Authorizations:

Path parameters

idstring
required

ID of the record you are acting upon.

Header parameters

x-apideck-consumer-idstring
required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring
required

The ID of your Unify application

x-apideck-service-idstring

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.

Query parameters

rawboolean
Default:true

Include raw response. Mostly used for debugging purposes

Responses

200Activity
400Bad Request
401Unauthorized
402Payment Required
404The specified resource was not found
422Unprocessable

Response example

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "activities",
  "operation": "one",
  "data": {
    "id": "12345"
  }
}