Replace collaborators article with deprecation message

dnsimple · Dec 17, 2024 · 5d7c025 · 5d7c025
1 parent 2798b9d
commit 5d7c025
Showing 1 changed file with 3 additions and 132 deletions.
diff --git a/content/v2/domains/collaborators.markdown b/content/v2/domains/collaborators.markdown
@@ -5,135 +5,6 @@ excerpt: This page documents the DNSimple collaborators API v2.
 
 # Collaborators API
 
-* TOC
-{:toc}
-
-## List collaborators {#listDomainCollaborators}
-
-    GET /:account/domains/:domain/collaborators
-
-List collaborators for the domain in the account.
-
-### Parameters
-
-Name | Type | Description
------|------|------------
-`:account` | `integer` | The account id
-`:domain` | `string`, `integer` | The domain name or id
-
-### Example
-
-List all collaborators for the domain `example.com` in the account `1010`:
-
-    curl  -H 'Authorization: Bearer <token>' \
-          -H 'Accept: application/json' \
-          https://api.dnsimple.com/v2/1010/domains/example.com/collaborators
-
-### Response
-
-Responds with HTTP 200.
-
-~~~json
-<%= pretty_print_fixture("/api/listCollaborators/success.http") %>
-~~~
-
-### Errors
-
-Responds with [HTTP 401](/v2#unauthorized) in case of case of authentication issues.
-
-
-## Add a collaborator {#addDomainCollaborator}
-
-At the time of the add, a collaborator may or may not have a DNSimple account.
-
-In case the collaborator doesn't have a DNSimple account, the system will invite her/him to register to DNSimple first and then to accept the collaboration invitation.
-
-In the other case, she/he is automatically added to the domain as collaborator. She/he can decide to reject the invitation later.
-
-    POST /:account/domains/:domain/collaborators
-
-### Parameters
-
-Name | Type | Description
------|------|------------
-`:account` | `integer` | The account id
-`:domain` | `string`, `integer` | The domain name or id
-
-### Example
-
-Add a collaborator for the domain `example.com` in the account `1010`:
-
-    curl  -H 'Authorization: Bearer <token>' \
-          -H 'Accept: application/json' \
-          -H 'Content-Type: application/json' \
-          -X POST \
-          -d '<json>' \
-          https://api.dnsimple.com/v2/1010/domains/example.com/collaborators
-
-### Input
-
-Name | Type | Description
------|------|------------
-`email` | `string` | **Required**.
-
-##### Example
-
-~~~json
-{
-  "email": "[email protected]"
-}
-~~~
-
-### Response
-
-When the collaborator already has a DNSimple account:
-
-~~~json
-<%= pretty_print_fixture("/api/addCollaborator/success.http") %>
-~~~
-
-When the collaborator doesn't have a DNSimple account:
-
-~~~json
-<%= pretty_print_fixture("/api/addCollaborator/invite-success.http") %>
-~~~
-
-Responds with HTTP 201 on success.
-
-### Errors
-
-Responds with [HTTP 400](/v2#bad-request) if the collaborator cannot be added.
-
-Responds with [HTTP 401](/v2#unauthorized) in case of case of authentication issues.
-
-
-## Remove a collaborator {#removeDomainCollaborator}
-
-    DELETE /:account/domains/:domain/collaborators/:collaborator
-
-### Parameters
-
-Name | Type | Description
------|------|------------
-`:account` | `integer` | The account id
-`:domain` | `string`, `integer` | The domain name or id
-`:collaborator` | `integer` | The collaborator id
-
-### Example
-
-Remove a collaborator `100` from the domain `example.com` in the account `1010`:
-
-    curl  -H 'Authorization: Bearer <token>' \
-          -H 'Accept: application/json' \
-          -X DELETE \
-          https://api.dnsimple.com/v2/1010/domains/example.com/collaborators/100
-
-### Response
-
-Responds with HTTP 204 on success.
-
-### Errors
-
-Responds with [HTTP 400](/v2#bad-request) if the collaborator cannot be removed
-
-Responds with [HTTP 401](/v2#unauthorized) in case of case of authentication issues.
+<warning>
+All domain collaborator endpoints have been deprecated in favor of our [Domain Access Control](/articles/domain-access-control) feature as of December 31, 2024.
+</warning>