Preguntas Frequentes
This guide will give you everything you need to start using the Docs Marketing API to manage audiences, control automation workflows, sync email activity with your database, and more.
FaQ 1
The Docs Marketing API provides programmatic access to Docs data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.
To use the Docs API, you need a Docs account. What you can do with the API depends on what level of Docs plan you have. Once you have an account and are logged in, you can get an API key and begin making calls to the API.
Using Docs
Whether you're managing your own campaigns, providing Docs services to your customers or clients, or writing a mobile app, the Docs Marketing API has features to manage and sync your contact data.
You can also use the Docs API to handle data in different ways for different purposes. If you are syncing a large amount of data with Docs, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Docs accounts, you should authenticate with OAuth 2. And if you're developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the Docs API's functionality.
FaQ 2
The Marketing API generally follows REST conventions, with some deviations.
- Resources are typically nouns like subscribers or campaigns.
- Subresources can be multiply nested under resources.
- Actions are usually represented by HTTP methods.
- Responses use the generic JSON content type.
We use the API Specification to describe each endpoint. The API self-description also contains type information to help you error-check your requests.
The root url for the API is https://<dc>.api.docs.com/3.0/. The <dc> part of the URL corresponds to the data center for your account. For example, if the data center for your account is us6, all API endpoints for your account are available relative to https://us6.api.docs.com/3.0/.
There are a few ways to find your data center. It's the first part of the URL you see in the API keys section of your account; if the URL is https://us6.docs.com/account/api/, then the data center subdomain is us6. It's also appended to your API key in the form key-dc; if your API key is 0123456789abcdef0123456789abcde-us6, then the data center subdomain is us6. And finally, if you're connecting via OAuth 2, you can find the data center associated with the token via the OAuth Metadata endpoint; for more information, see the OAuth guide.
Note: You will see the <dc> placeholder or an actual data center subdomain in examples throughout this documentation. Either way, make sure to replace it in your code with the data center subdomain for your account, or your request may generate an error.
FaQ 3
The Docs Marketing API provides programmatic access to Docs data and functionality, allowing developers to build custom features to do things like sync email activity and campaign analytics with their database, manage audiences and campaigns, and more.
To use the Docs API, you need a Docs account. What you can do with the API depends on what level of Docs plan you have. Once you have an account and are logged in, you can get an API key and begin making calls to the API.
Using Docs
Whether you're managing your own campaigns, providing Docs services to your customers or clients, or writing a mobile app, the Docs Marketing API has features to manage and sync your contact data.
You can also use the Docs API to handle data in different ways for different purposes. If you are syncing a large amount of data with Docs, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Docs accounts, you should authenticate with OAuth 2. And if you're developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the Docs API's functionality.
FaQ 4
The Marketing API generally follows REST conventions, with some deviations.
- Resources are typically nouns like subscribers or campaigns.
- Subresources can be multiply nested under resources.
- Actions are usually.
- Responses use the generic JSON content t represented by HTTP methods.
We use the API Specification to describe each endpoint. The API self-description also contains type information to help you error-check your requests.
The root url for the API is https://<dc>.api.docs.com/3.0/. The <dc> part of the URL corresponds to the data center for your account. For example, if the data center for your account is us6, all API endpoints for your account are available relative to https://us6.api.docs.com/3.0/.
There are a few ways to find your data center. It's the first part of the URL you see in the API keys section of your account; if the URL is https://us6.docs.com/account/api/, then the data center subdomain is us6. It's also appended to your API key in the form key-dc; if your API key is 0123456789abcdef0123456789abcde-us6, then the data center subdomain is us6. And finally, if you're connecting via OAuth 2, you can find the data center associated with the token via the OAuth Metadata endpoint; for more information, see the OAuth guide.
Note: You will see the <dc> placeholder or an actual data center subdomain in examples throughout this documentation. Either way, make sure to replace it in your code with the data center subdomain for your account, or your request may generate an error.
FaQ 5
The Marketing API generally follows REST conventions, with some deviations.
- Resources are typically nouns like subscribers or campaigns.
- Subresources can be multiply nested under resources.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Actions are usually #1.
- Responses use the generic JSON content t represented by HTTP methods.
We use the API Specification to describe each endpoint. The API self-description also contains type information to help you error-check your requests.
The root url for the API is https://<dc>.api.docs.com/3.0/. The <dc> part of the URL corresponds to the data center for your account. For example, if the data center for your account is us6, all API endpoints for your account are available relative to https://us6.api.docs.com/3.0/.
There are a few ways to find your data center. It's the first part of the URL you see in the API keys section of your account; if the URL is https://us6.docs.com/account/api/, then the data center subdomain is us6. It's also appended to your API key in the form key-dc; if your API key is 0123456789abcdef0123456789abcde-us6, then the data center subdomain is us6. And finally, if you're connecting via OAuth 2, you can find the data center associated with the token via the OAuth Metadata endpoint; for more information, see the OAuth guide.
Note: You will see the <dc> placeholder or an actual data center subdomain in examples throughout this documentation. Either way, make sure to replace it in your code with the data center subdomain for your account, or your request may generate an error.
Using Docs
Whether you're managing your own campaigns, providing Docs services to your customers or clients, or writing a mobile app, the Docs Marketing API has features to manage and sync your contact data.
You can also use the Docs API to handle data in different ways for different purposes. If you are syncing a large amount of data with Docs, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Docs accounts, you should authenticate with OAuth 2. And if you're developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the Docs API's functionality.
Using Docs
Whether you're managing your own campaigns, providing Docs services to your customers or clients, or writing a mobile app, the Docs Marketing API has features to manage and sync your contact data.
You can also use the Docs API to handle data in different ways for different purposes. If you are syncing a large amount of data with Docs, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Docs accounts, you should authenticate with OAuth 2. And if you're developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the Docs API's functionality.
Using Docs
Whether you're managing your own campaigns, providing Docs services to your customers or clients, or writing a mobile app, the Docs Marketing API has features to manage and sync your contact data.
You can also use the Docs API to handle data in different ways for different purposes. If you are syncing a large amount of data with Docs, you can use batches to avoid hitting the API request limits. For building integrations that let other users access data from their own Docs accounts, you should authenticate with OAuth 2. And if you're developing an app for iOS or Android, the Mobile SDK provides an easy way to work with a mobile-focused subset of the Docs API's functionality.