The Design Pickle API makes it easy to manage your design workflow. It lets you create, update, and track design requests automatically. Built for users who are comfortable with APIs, it helps simplify and speed up design processes. For in-depth, interactive documentation, visit our official API documentation.
1. Authentication & Integration Keys
An integration key is required to ensure secure access. You can generate an integration key through the Jar or via the API itself. Additionally, API-generated keys can be mapped to specific users for enhanced access control.
Learn how to obtain an integration key here.
2. Creating a Design Request
Easily create new design requests with all the same options available in the Design Pickle Jar, including:
Request type ID (retrievable via API documentation)
Directions, file formats, and sizes
Copy, brand associations, and reference files
Note: Reference files must be hosted on a publicly accessible URL at the time of submission.
Requests can be saved as drafts or submitted immediately to a Design Pickle creative using the submit boolean parameter.
3. Updating a Design Request
Modify existing requests by updating:
Files
Formats
Directions
Copy
Sizes
This ensures your creative receives the most accurate instructions.
4. Viewing Design Requests
Retrieve one or multiple design requests based on:
Status (e.g., draft, for review, archived)
Specific request ID
5. Canceling a Design Request
Do you need to cancel a request? A dedicated API endpoint allows users to remove requests that are no longer needed.
6. Marking a Design Request as Complete
Once a request has been finalized and approved, you can mark it as complete to indicate that no further revisions are needed.
7. Retrieving Brand Information
Access brand-related information to ensure all design requests stay consistent with your brand guidelines.
Need further help? Email us through [email protected], or click the chat button on the lower right-hand side of this window to chat with us.