Save or update your creator shortlist
curl --request POST \
--url https://api.influship.com/v1/shortlists \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"brief": "<string>",
"profiles": [
{
"platform": "instagram",
"username": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expected_version": 123,
"notes": ""
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
brief: '<string>',
profiles: [{platform: 'instagram', username: '<string>'}],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expected_version: 123,
notes: ''
})
};
fetch('https://api.influship.com/v1/shortlists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.influship.com/v1/shortlists"
payload = {
"name": "<string>",
"brief": "<string>",
"profiles": [
{
"platform": "instagram",
"username": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expected_version": 123,
"notes": ""
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brief": "<string>",
"profiles": [
{
"platform": "instagram",
"username": "<string>"
}
],
"notes": "<string>",
"version": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid value for parameter 'limit': must be between 1 and 100",
"param": "limit",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "unauthorized",
"message": "API key missing or invalid",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "payment_required",
"message": "Payment authentication is required.",
"status_code": 402,
"reason_code": "PAYMENT_ACTION_REQUIRED",
"next_step": "complete_authentication",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "forbidden",
"message": "Your plan does not include access to this endpoint",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "not_found",
"message": "Creator with ID '123e4567-e89b-12d3-a456-426614174000' not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid Instagram username format",
"param": "username",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded (per minute)",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "service_unavailable",
"message": "Live Instagram data is temporarily unavailable. Please retry shortly.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"details": {
"retry_after_seconds": 60,
"upstream_error": "upstream_rate_limited"
}
}
}Shortlists
Save or update your creator shortlist
Save up to eight Instagram profiles with a campaign brief and notes. Updating requires the current saved version. Reopen the selected profiles to retrieve their latest stored metrics and evidence.
POST
/
v1
/
shortlists
Save or update your creator shortlist
curl --request POST \
--url https://api.influship.com/v1/shortlists \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"brief": "<string>",
"profiles": [
{
"platform": "instagram",
"username": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expected_version": 123,
"notes": ""
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
brief: '<string>',
profiles: [{platform: 'instagram', username: '<string>'}],
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
expected_version: 123,
notes: ''
})
};
fetch('https://api.influship.com/v1/shortlists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.influship.com/v1/shortlists"
payload = {
"name": "<string>",
"brief": "<string>",
"profiles": [
{
"platform": "instagram",
"username": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expected_version": 123,
"notes": ""
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"brief": "<string>",
"profiles": [
{
"platform": "instagram",
"username": "<string>"
}
],
"notes": "<string>",
"version": 123,
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid value for parameter 'limit': must be between 1 and 100",
"param": "limit",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "unauthorized",
"message": "API key missing or invalid",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "payment_required",
"message": "Payment authentication is required.",
"status_code": 402,
"reason_code": "PAYMENT_ACTION_REQUIRED",
"next_step": "complete_authentication",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "forbidden",
"message": "Your plan does not include access to this endpoint",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "not_found",
"message": "Creator with ID '123e4567-e89b-12d3-a456-426614174000' not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "validation_error",
"message": "Invalid Instagram username format",
"param": "username",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded (per minute)",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "service_unavailable",
"message": "Live Instagram data is temporarily unavailable. Please retry shortly.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"details": {
"retry_after_seconds": 60,
"upstream_error": "upstream_rate_limited"
}
}
}Authorizations
Body
application/json
Required string length:
1 - 80Required string length:
1 - 500Required array length:
1 - 8 elementsShow child attributes
Show child attributes
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
x <= 2147483647Maximum string length:
2000Response
Successful response
Show child attributes
Show child attributes