API Documentation
Endpoints
- Analytics
- Auth
- System
- User
- Workspace
- GETGet workspaces
- POSTCreate workspace
- GETGet workspace
- DELDelete workspace
- PATCHUpdate workspace
- GETGet all invoices that belong to the workspace
- GETReturn the generated invoice PDF
- GETGet workspace members
- POSTInvite workspace member
- POSTJoin to a workspace
- DELRemove workspace member
- GETGet workspace subscription
- DELCancel workspace subscription
- GET
- Domain
- Link
- QR Code
Workspace
Update workspace
Update the workspace by its ID.
PATCH
/
v1
/
workspaces
/
{workspace_id}
Copy
curl --request PATCH \
--url https://api.ziplink.click/v1/workspaces/{workspace_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"billing_address_city": "cus_JgZ1z1z1z1z1z1",
"billing_address_country": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_1": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_2": "cus_JgZ1z1z1z1z1z1",
"billing_address_postal_code": "cus_JgZ1z1z1z1z1z1",
"billing_address_state": "cus_JgZ1z1z1z1z1z1",
"email": "[email protected]",
"name": "ACME Inc."
}'
Copy
{
"billing_address_city": "cus_JgZ1z1z1z1z1z1",
"billing_address_country": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_1": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_2": "cus_JgZ1z1z1z1z1z1",
"billing_address_postal_code": "cus_JgZ1z1z1z1z1z1",
"billing_address_state": "cus_JgZ1z1z1z1z1z1",
"created_at": "2023-11-07T05:31:56Z",
"email": "[email protected]",
"id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
"name": "ACME Inc.",
"updated_at": "2023-11-07T05:31:56Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the workspace.
Example:
"ab782971-4d79-47ab-8685-77cf5a34b2bb"
Body
application/json
Response
200
application/json
OK
A workspace in the system.
Copy
curl --request PATCH \
--url https://api.ziplink.click/v1/workspaces/{workspace_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"billing_address_city": "cus_JgZ1z1z1z1z1z1",
"billing_address_country": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_1": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_2": "cus_JgZ1z1z1z1z1z1",
"billing_address_postal_code": "cus_JgZ1z1z1z1z1z1",
"billing_address_state": "cus_JgZ1z1z1z1z1z1",
"email": "[email protected]",
"name": "ACME Inc."
}'
Copy
{
"billing_address_city": "cus_JgZ1z1z1z1z1z1",
"billing_address_country": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_1": "cus_JgZ1z1z1z1z1z1",
"billing_address_line_2": "cus_JgZ1z1z1z1z1z1",
"billing_address_postal_code": "cus_JgZ1z1z1z1z1z1",
"billing_address_state": "cus_JgZ1z1z1z1z1z1",
"created_at": "2023-11-07T05:31:56Z",
"email": "[email protected]",
"id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
"name": "ACME Inc.",
"updated_at": "2023-11-07T05:31:56Z"
}
Assistant
Responses are generated using AI and may contain mistakes.