Check Creator Outreach Eligibility

POST

/affiliate_seller/202610/creator_outreach/eligibility/check

Check whether creators meet the shop’s connection and quota requirements before initiating creator outreach.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

creator_infos

required

Creator information to evaluate for the shop’s outreach eligibility. Provide one to 100 entries with unique Creator Open IDs.

Array<object>

object

creator_open_id

required

Creator Open ID.

string

Example

{
  "creator_infos": [
    {
      "creator_open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg"
    },
    {
      "creator_open_id": "uBXcdQAAAABnVV3ron5S1wVZvVW4QD7DJCJQ3n6B3-xe88k9S0H1zh"
    }
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

creator_eligibility_results

Per-creator raw connection and quota eligibility facts.

Array<object>

object

creator_level

Creator level evaluated by the quota rules.

integer format: int64

creator_open_id

Creator Open ID from the request.

string

is_blocked

Whether a blocking relationship prevents the shop and creator from connecting.

boolean

is_connected

Whether the shop is already connected with the creator.

boolean

is_creator_follower_count_threshold_met

Whether the creator meets the follower count threshold required for the shop to initiate creator outreach.

boolean

is_creator_level_quota_available

Whether outreach quota is available for the creator’s level.

boolean

is_paired

Whether the shop is paired with the creator.

boolean

ineligible_creator_levels

Creator levels that prevent quota consumption for the full requested batch. This is an empty array when no creator level prevents quota consumption.

Array<integer>

is_batch_quota_consumable

Whether quota can be consumed for the full requested creator batch.

boolean

Example

{
  "code": 0,
  "data": {
    "creator_eligibility_results": [
      {
        "creator_level": 3,
        "creator_open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg",
        "is_blocked": false,
        "is_connected": false,
        "is_creator_follower_count_threshold_met": true,
        "is_creator_level_quota_available": false,
        "is_paired": false
      },
      {
        "creator_level": 1,
        "creator_open_id": "uBXcdQAAAABnVV3ron5S1wVZvVW4QD7DJCJQ3n6B3-xe88k9S0H1zh",
        "is_blocked": false,
        "is_connected": true,
        "is_creator_follower_count_threshold_met": true,
        "is_creator_level_quota_available": true,
        "is_paired": false
      }
    ],
    "ineligible_creator_levels": [
      3
    ],
    "is_batch_quota_consumable": false
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}