Skip to main content
PUT
/
partners
/
{id}
Update partner
curl --request PUT \
  --url https://api.agentic.scope3.com/api/v2/partner/partners/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Activation Corp",
  "description": "Updated description for Acme Activation"
}
'
{
  "id": "12345",
  "name": "Acme Activation",
  "status": "ACTIVE",
  "createdAt": "2025-01-15T10:30:00Z",
  "updatedAt": "2025-01-20T14:45:00Z",
  "description": "Activation partner for Acme Corporation"
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
id
string
required

Unique identifier for the partner

Minimum string length: 1
Example:

"12345"

Body

application/json
​
name
string

Updated name of the partner

Required string length: 1 - 255
Example:

"Acme Activation Corp"

​
description
string

Updated description of the partner

Maximum string length: 1000
Example:

"Updated description for Acme Activation"

Response

Update partner

Partner resource representation

​
id
string
required

Unique identifier for the partner

Example:

"12345"

​
name
string
required

Name of the partner

Example:

"Acme Activation"

​
status
enum<string>
required

Current status of the partner

Available options:
ACTIVE,
ARCHIVED
​
createdAt
string<date-time>
required

When the partner was created (ISO 8601)

Example:

"2025-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

When the partner was last updated (ISO 8601)

Example:

"2025-01-20T14:45:00Z"

​
description
string

Description of the partner

Example:

"Activation partner for Acme Corporation"