Skip to content

Check sender profile capacity

Request

Check whether the team has capacity for the requested number of additional sender profiles within its current subscription limits. Returns monthly and yearly usage information (or null for each if the team has no active subscription on that cycle).

Security
bearerAuth
Path
idintegerrequired

Team ID.

Bodyapplication/jsonrequired
sender_profiles_limitinteger, >= 1required

Number of additional sender profiles to check capacity for.

Example:1
POST
/id/api/teams/{id}/check-limits
curl -i -X POST \
  'https://leadgen.grinfi.io/id/api/teams/{id}/check-limits' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender_profiles_limit": 1
  }'

Responses

Capacity information.

Bodyapplication/json
monthlyobject or null

Monthly subscription capacity, null if no monthly plan.

yearlyobject or null

Yearly subscription capacity, null if no yearly plan.

Response
{
  "monthly": {},
  "yearly": {}
}