API Docs
Need help?
Back to Agencies API

Update Agency

Updates editable fields for an agency profile.

Request Details

path Parameters

FieldTypeRequiredDescription
agencyId
string
YesThe ID of the agency to update.

body Parameters

FieldTypeRequiredDescription
id
string
YesUnique identifier for the agency
name
string
YesName of the agency
email
string
YesPublic contact email address of the agency
phone
string
YesPublic contact phone number of the agency
isApproved
boolean
YesIndicates whether the agency has been approved by the platform
website
string
YesPublic website of the agency
createdAt
string
date-time
NoTimestamp when the user was created
updatedAt
string
date-time
NoTimestamp when the user was last updated
domain
object
AgencyDomain
YesDomain verification metadata. See AgencyDomain schema.
locations
array
AgencyLocation
YesList of physical or operational locations for the agency. See AgencyLocation schema.
settings
object
AgencySettings
YesAgency-specific settings. See AgencySettings schema.

Sample Request & Response

PUT
/agencies/{agencyId}
Updates editable fields for an agency profile.
Sample Request

Headers:

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <YOUR_API_KEY>"
}

Path Parameters:

{
  "agencyId": "string (required) - The ID of the agency to update."
}

Body:

{
  "name": "TalentFlow Partners",
  "website": "https://talentflow.com",
  "description": "Expanded coverage across North America."
}
Sample Response (200)
{
  "id": "agency_12345",
  "name": "TalentFlow Partners",
  "website": "https://talentflow.com",
  "description": "Expanded coverage across North America.",
  "updatedAt": "2024-07-24T12:15:00Z"
}