Skip to content
GigAI

Update a profile

PUT
/api/profiles/{profile_id}
curl --request PUT \
  --url http://127.0.0.1:8765/api/profiles/example \
  --header 'Content-Type: application/json' \
  --data '{ "label": "Backend", "titles": [ "Software Engineer" ] }'

Update a profile. search_settings on the default profile is a 409: it uses the setup settings (PUT /api/setup). An unknown key inside search_settings lists that object’s allowed_keys.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
profile_id
required
string

A profile id from GET /api/profiles.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
label
required

Profile name.

string
queries

Search queries.

array
resume_record_id

Stored resume record.

string
resume_revision_id

Stored resume revision.

string
search_settings

Any of {location, work_mode, countries, max_age_days} to change; null = same as default.

object
titles
required

Titles (non-empty).

array
titles_to_avoid

Words or phrases: a posting whose title holds one (whole words, any case) is not in this profile’s list.

array
Example
{
  "label": "Backend",
  "titles": [
    "Software Engineer"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Success.

Media typeapplication/json
object
key
additional properties
any
Example
{
  "profile": {
    "profile_id": "prof_1"
  }
}

400

Section titled “400”

Invalid_value

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "invalid_value",
    "message": "..."
  }
}

403

Section titled “403”

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Examplegenerated
{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404”

Not_found

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "not_found",
    "message": "..."
  }
}

409

Section titled “409”

Scout_profile_default_search_settings

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "scout_profile_default_search_settings",
    "message": "..."
  }
}

415

Section titled “415”

Unsupported_media_type: writes need Content-Type: application/json.

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Examplegenerated
{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

422

Section titled “422”

Wrong_type

Media typeapplication/json
object
error
required
object
allowed_keys
Array<string>
code
required
string
message
required
string
key
additional properties
any
Example
{
  "error": {
    "code": "wrong_type",
    "message": "..."
  }
}