Skip to content
GAMPEONCreate
New project

Send a friend request

POST
/v1/friends/requests
curl --request POST \
--url https://api.gampeon.com/v1/friends/requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "handle": "example" }'

If the other person already asked you, you are friends right away (status: friends). Blocks and the other person’s settings both answer 403 not_allowed, so a block is not revealed.

Not available with access tokens.

Rate limit: 20 per hour per account, 100 open requests, 1,000 friends.

Media typeapplication/json
object
handle
required

Handle, with or without @

string

Example generated

{
"handle": "example"
}

Request sent (200 if it already existed or was accepted)

Media typeapplication/json
object
status
required
string
Allowed values: pending friends

Example

{
"status": "pending"
}

Error codes: invalid_field, invalid_target

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: unauthorized

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: token_not_allowed, not_allowed

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: not_found

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Error codes: already_friends, too_many_pending, friend_limit

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Limit: 20 per hour per account, 100 open requests, 1,000 friends. Error codes: rate_limited

Media typeapplication/json
object
error
required

Machine-readable error code, for example not_found or rate_limited.

string
message

Human-readable detail. Only present for some errors.

string

Example generated

{
"error": "example",
"message": "example"
}

Report a problem with this pageOther ways to give feedback