Back to Agencies API
Update Agency
Updates editable fields for an agency profile.
Request Details
path Parameters
Field | Type | Required | Description |
---|---|---|---|
agencyId | string | Yes | The ID of the agency to update. |
body Parameters
Field | Type | Required | Description |
---|---|---|---|
id | string | Yes | Unique identifier for the agency |
name | string | Yes | Name of the agency |
string | Yes | Public contact email address of the agency | |
phone | string | Yes | Public contact phone number of the agency |
isApproved | boolean | Yes | Indicates whether the agency has been approved by the platform |
website | string | Yes | Public website of the agency |
createdAt | string date-time | No | Timestamp when the user was created |
updatedAt | string date-time | No | Timestamp when the user was last updated |
domain | object AgencyDomain | Yes | Domain verification metadata. See AgencyDomain schema. |
locations | array AgencyLocation | Yes | List of physical or operational locations for the agency. See AgencyLocation schema. |
settings | object AgencySettings | Yes | Agency-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"
}