Docs

Start here

Approve or decline a request to join

POST/v1/studio/projects/{project}/requests/{request}on https://api.auray.ai/v1

Approve a request — as the role asked for, or another you may give (role) — or decline it.

Approve a request — as the role asked for, or another you may give (role) — or decline it. An approved asker joins (or moves up) and is told — a join past the project's limits.members is refused studio_limit_reached; a declined one is not told, and may ask that project again after 7 days. Takes a key holding studio:write — Account offers it unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — a key with the scope the route names.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes
requeststringyes

#Body

application/json, required.

FieldTypeRequiredDefaultDescription
decisionstringyes—One of "approve", "decline".
rolestringno—One of "admin", "collaborator", "viewer".

#Example request

curl -X POST https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/requests/… \
  -H "Authorization: Bearer $AURAY_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "decision": "approve",
  "role": "viewer"
}'

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "access_request".
idstringyes—
project_idstringyes—
rolestringyes—One of "admin", "collaborator", "viewer".
messagestringyes—0 to 300 characters. May be null.
statestringyes—One of "pending", "approved", "declined", "withdrawn".
byobjectyes—Somebody as a project shows them: their membership's id while they are in it and the public Community profile they chose — never an account or an address.
by.member_idstringyes—May be null.
by.namestringyes—May be null.
by.handlestringyes—May be null.
by.avatar_urlstringyes—A URL. May be null.
by.leftbooleanyes—Gone from the project since; what they wrote stays, with their name.
created_atstringyes—
decided_atstringyes—May be null.
request_idstringno—Mirrored in the X-Request-Id header.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#404 Not Found

#409 Conflict

#413 Payload Too Large

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
413Payload Too Large
429Too Many Requests
500Internal Server Error
503Service Unavailable

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close