FansquareAPI reference
Open the app

Fans

Assign a fan to an employee

PUT/v1/accounts/{account_id}/fans/{fan_id}/assignment

Assigns the fan to an employee. Calling the endpoint again with a different user_id updates the assignment.

Required scopewrite:assignments
Rate limit60 requests per minute
curl -X PUT 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/fans/a6df8022-e509-4575-ad28-e29c2d1d42dc/assignment' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W"
}'
{
  "assigned_user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W"
}

Parameters

Headers

  • Fansquare-Versionstringrequired

    API version to pin. Accepts the mineral name or the release date of a version.

Path

  • account_idstringrequired

    MYM account id (account.external_id in GET /v1/creators).

    min length 1
  • fan_idstringrequired

    MYM fan id.

    format uuid

Body

application/json

  • user_idstringrequired

    Fansquare id of the employee to assign (see GET /v1/employees). Must be an active member of the agency.

    min length 1

Response

OK, application/json

  • assigned_user_idstringrequired

    Fansquare id of the employee now assigned to the fan.

curl -X PUT 'https://api.fansquare.so/v1/accounts/c851d9d6-b90b-4958-aed2-2fdaa2fe21a3/fans/a6df8022-e509-4575-ad28-e29c2d1d42dc/assignment' \
  -H "Authorization: Bearer $API_KEY" \
  -H "Fansquare-Version: Amethyste" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W"
}'
{
  "assigned_user_id": "ki9DZXxpgGz7KiDqHj88eCxHg56W"
}