Skip to content
warmupDocs

Update a project

PATCH
/projects/{id}
curl --request PATCH \
  --url https://api.warmup.social/projects/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "active", "language": "en-US" }'

Partial update. Send at least one field; null clears an optional field.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Example 

00000000-0000-0000-0000-000000000000

Project UUID.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
>= 1 properties
name
string
>= 1 characters <= 80 characters
status
string
Allowed values: farm active paused archived
gender
string
nullable
Allowed values: male female
language

BCP 47 language tag.

string
nullable
geo

ISO 3166-1 alpha-2 country code.

string
nullable

Example 

{
  "status": "active",
  "language": "en-US"
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated project.

Media typeapplication/json
object
id
required
string format: uuid
name
required
string
>= 1 characters <= 80 characters
createdAt
required
string format: date-time
status
required
string
Allowed values: farm active paused archived
gender
required
string
nullable
Allowed values: male female
language
required

BCP 47 language tag.

string
nullable
geo
required

ISO 3166-1 alpha-2 country code.

string
nullable
connections
required
object
facebook
required

The connected account; null — the network is not connected.

object
status
required
string
Allowed values: active needs_reauth revoked
username
required
string
nullable
displayName
required
string
nullable
avatarUrl
required
string
nullable
missingScopes
required
Array<string>
statusReason
required
string
nullable
connectedAt
required
string format: date-time
instagram
required

The connected account; null — the network is not connected.

object
status
required
string
Allowed values: active needs_reauth revoked
username
required
string
nullable
displayName
required
string
nullable
avatarUrl
required
string
nullable
missingScopes
required
Array<string>
statusReason
required
string
nullable
connectedAt
required
string format: date-time
threads
required

The connected account; null — the network is not connected.

object
status
required
string
Allowed values: active needs_reauth revoked
username
required
string
nullable
displayName
required
string
nullable
avatarUrl
required
string
nullable
missingScopes
required
Array<string>
statusReason
required
string
nullable
connectedAt
required
string format: date-time
limits
required
object
used
required
integer
max
required
integer

Example 

{
  "name": "Nails studio",
  "status": "farm",
  "gender": "male",
  "language": "en-US",
  "geo": "US",
  "connections": {
    "facebook": {
      "status": "active",
      "username": "chillax_nails"
    },
    "instagram": {
      "status": "active",
      "username": "chillax_nails"
    },
    "threads": {
      "status": "active",
      "username": "chillax_nails"
    }
  },
  "limits": {
    "used": 1,
    "max": 3
  }
}

400

Section titled “400”

Invalid request.

Media typeapplication/json
object
statusCode
required
integer
message
required
One of:
string
error
string
key
additional properties
any

Example 

{
  "statusCode": 400,
  "message": "Invalid request",
  "error": "Bad Request"
}

401

Section titled “401”

The Bearer token is missing or invalid.

Media typeapplication/json
object
statusCode
required
integer
message
required
One of:
string
error
string
key
additional properties
any

Example 

{
  "statusCode": 400,
  "message": "Invalid request",
  "error": "Bad Request"
}

404

Section titled “404”

The requested resource was not found.

Media typeapplication/json
object
statusCode
required
integer
message
required
One of:
string
error
string
key
additional properties
any

Example 

{
  "statusCode": 400,
  "message": "Invalid request",
  "error": "Bad Request"
}