Remove a friend

Ends a friendship by its id.

DELETE

/v1/friends/{friendshipId}

const url = 'https://api.shiftsync.app/v1/friends/1';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.shiftsync.app/v1/friends/1 \
  --header 'Authorization: Bearer <token>'

Authorizations

oauth2
friends:write

Parameters

Path Parameters

friendshipId

required

number

Responses

200

Deletion result

application/json

object

success

required

boolean

Example

{
  "success": true
}