For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Response Codes

Refer to the below response code glossary to help you troubleshoot any errors.

Glossary

Response Code

Messages

Explanation

200 OK

The request was successful!

N/A

400 Bad Request

Request validation failed on an input.

Check that your inputs are entered correctly.

Note that participant lookups return a 400 (not a 404) when no participant exists for the given ID or email, and emailing a participant returns a 400 if they have unsubscribed.

402 Usage Limit

Usage limit exceeded.

You've reached a plan limit (such as your participant usage limit, or your plan's program limit when creating a program) and will need to upgrade to the next tier.

402 Payment Method Required

You must add a payment method to your account to use the REST API for affiliate programs.

N/A

403 Not Authorized

You are not allowed to perform that action.

Or no valid participant access token provided.

Your API key may be missing, revoked, contain a typo, lack the required scope, or be limited to different programs. You may also be trying to access a program outside the team or program list assigned to the API key. Verify that your API key has the required scope and program access. To create or change keys in Settings, use an owner, Admin, or teammate with Manage API access.

403 Paid Plan Required

A paid plan is required to use the GrowSurf REST API

A paid plan is required to use the REST API with referral programs. For affiliate programs, a payment method on file is required instead (see 402 Payment Method Required).

403 Email Not Verified

The team owner email address must be verified to use this endpoint. Check the owner inbox, or resend it via POST /v2/team/owner/verification-email.

Program and resource endpoints remain locked until the owner verifies the email address. Check the team's GrowSurf verification state with GET /v2/team.

403 Account Disabled

This account has been disabled.

The team bound to the API key has been disabled. Please contact support if you believe this is a mistake.

404 Resource Not Found

The requested resource does not exist.

You may be trying to request a resource that does not exist or was deleted.

406 Invalid State

The resource is not in a state that permits this operation.

The resource cannot be changed from its current state — for example, approving or fulfilling a participant reward that has already been fulfilled, or approving a commission that has already been paid out.

409 Conflict Duplicate Request

Conflicting duplicate request.

An identical request is already in progress — wait for it to complete before retrying.

When creating an account, a 409 means an account with this email already exists.

422 Unprocessable Entity Error

This endpoint is only available for referral programs. Your program is an affiliate program.

You may be trying to call an endpoint that is only valid to referral programs (or vice versa with affiliate programs).

422 Participant Blocked

Participant was detected as a high-risk fraudster and was blocked from joining.

The person may be a high-risk fraudster, and has been blocked from entering the program. Learn more about how GrowSurf's anti-fraud system works. Please check that your program's anti-fraud settings are not set to Strict, or that you do not have the email or IP address blacklisted.

429 Too Many Requests

You have reached a rate limit.

You have sent too many requests in a given time. Some operations (such as creating accounts or sending participant emails) have their own stricter limits. See Rate Limits and Max Connections for more details on rate limits.

5XX Internal Server Error

The GrowSurf server is inaccessible or offline -- that's our fault! Check for updates on our status page.

N/A

Last updated

Was this helpful?