Support access
Withdraw support access request
Cancel a support access request you raised.
POST
/
api
/
v1
/
support-access
/
grants
/
{grant_id}
/
withdraw
curl -X POST "https://api.wordsmith.ai/api/v1/support-access/grants/9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d/withdraw" \
-H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"reason": "Raised against the wrong repository."
}'
{
"id": "9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d",
"member_id": "5b0e6f1e-8a43-4f0e-9d0a-3e2c51f8a7b4",
"requested_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
"requested_by_wordsmith": false,
"ticket_ref": "SUP-1042",
"ticket_url": "https://support.example.com/tickets/1042",
"justification": "Reproduce the export failure on the Q3 supplier contracts repository.",
"data_owner_id": "828b17cf-5f09-4edd-bcba-9d1de130a2e6",
"scope": "resources",
"resources": [
{
"kind": "repository",
"id": "0f6a3c1e-2b4d-4e8f-9a1b-3c5d7e9f1a2b",
"name": "Supplier contracts Q3"
}
],
"role_id": "72f02d30-2d67-40b0-b5cb-859dbb45d485",
"starts_at": "2026-11-17T10:00:00Z",
"ends_at": "2026-11-17T14:00:00Z",
"separate_approvers": false,
"required_approvals": [
"admin"
],
"requested_at": "2026-11-17T09:55:00Z",
"approval_expires_at": "2026-11-18T09:55:00Z",
"status": "withdrawn",
"phase": "closed",
"approvals": [],
"closed_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
"closed_by_wordsmith": false,
"closed_at": "2026-11-17T10:05:00Z",
"close_reason": "Raised against the wrong repository."
}
Cancels a support access request or grant that the caller raised. Use it when the request was raised by mistake. To end someone else’s grant, revoke it.
Authentication
Requires an API key, or an OAuth token withdirectory:admin. directory:admin is never granted by default. Only the member who raised the request can withdraw it. A Wordsmith support member is always refused, whatever role it holds. Support access must be turned on for your organisation.
Path parameters
Body parameters
Response
Returns200 with the closed grant.
curl -X POST "https://api.wordsmith.ai/api/v1/support-access/grants/9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d/withdraw" \
-H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"reason": "Raised against the wrong repository."
}'
{
"id": "9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d",
"member_id": "5b0e6f1e-8a43-4f0e-9d0a-3e2c51f8a7b4",
"requested_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
"requested_by_wordsmith": false,
"ticket_ref": "SUP-1042",
"ticket_url": "https://support.example.com/tickets/1042",
"justification": "Reproduce the export failure on the Q3 supplier contracts repository.",
"data_owner_id": "828b17cf-5f09-4edd-bcba-9d1de130a2e6",
"scope": "resources",
"resources": [
{
"kind": "repository",
"id": "0f6a3c1e-2b4d-4e8f-9a1b-3c5d7e9f1a2b",
"name": "Supplier contracts Q3"
}
],
"role_id": "72f02d30-2d67-40b0-b5cb-859dbb45d485",
"starts_at": "2026-11-17T10:00:00Z",
"ends_at": "2026-11-17T14:00:00Z",
"separate_approvers": false,
"required_approvals": [
"admin"
],
"requested_at": "2026-11-17T09:55:00Z",
"approval_expires_at": "2026-11-18T09:55:00Z",
"status": "withdrawn",
"phase": "closed",
"approvals": [],
"closed_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
"closed_by_wordsmith": false,
"closed_at": "2026-11-17T10:05:00Z",
"close_reason": "Raised against the wrong repository."
}
Errors
| Status | error_code | When |
|---|---|---|
| 400 | invalid_request_body | reason is not a string or is too long. |
| 403 | insufficient_scope | The OAuth token does not hold directory:admin. |
| 403 | forbidden | The caller lacks the support access permission, is a Wordsmith support member, or support access is off for your organisation. |
| 403 | forbidden | The caller may not withdraw this grant. |
| 404 | resource_not_found | No grant in your organisation has this id, or the caller may not see it. |
| 409 | resource_conflict | The grant has already ended, lapsed or expired, or it changed at the same moment. |
⌘I
curl -X POST "https://api.wordsmith.ai/api/v1/support-access/grants/9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d/withdraw" \
-H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"reason": "Raised against the wrong repository."
}'
{
"id": "9d4c2b7a-1f3e-4a5b-8c6d-7e8f9a0b1c2d",
"member_id": "5b0e6f1e-8a43-4f0e-9d0a-3e2c51f8a7b4",
"requested_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
"requested_by_wordsmith": false,
"ticket_ref": "SUP-1042",
"ticket_url": "https://support.example.com/tickets/1042",
"justification": "Reproduce the export failure on the Q3 supplier contracts repository.",
"data_owner_id": "828b17cf-5f09-4edd-bcba-9d1de130a2e6",
"scope": "resources",
"resources": [
{
"kind": "repository",
"id": "0f6a3c1e-2b4d-4e8f-9a1b-3c5d7e9f1a2b",
"name": "Supplier contracts Q3"
}
],
"role_id": "72f02d30-2d67-40b0-b5cb-859dbb45d485",
"starts_at": "2026-11-17T10:00:00Z",
"ends_at": "2026-11-17T14:00:00Z",
"separate_approvers": false,
"required_approvals": [
"admin"
],
"requested_at": "2026-11-17T09:55:00Z",
"approval_expires_at": "2026-11-18T09:55:00Z",
"status": "withdrawn",
"phase": "closed",
"approvals": [],
"closed_by": "4c98ef69-d5ef-4471-a2b8-89ded5b7b121",
"closed_by_wordsmith": false,
"closed_at": "2026-11-17T10:05:00Z",
"close_reason": "Raised against the wrong repository."
}