Skip to main content
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
platform_accounts
/
{id}
/
deactivate
Deactivate platform account
curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/platform_accounts/{id}/deactivate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "platform_account_id": "<string>",
  "name": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "platform_account_id": "<string>",
  "name": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "platform_integration_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
id
string<uuid>
required

A UUID string identifying this platform account.

​
organization_id
string<uuid>
required

A UUID string identifying the organization.

​
workspace_id
string<uuid>
required

A UUID string identifying the workspace.

Body

​
platform_account_id
string
required

External platform account ID

Maximum string length: 255
​
name
string
required
Maximum string length: 255
​
platform
enum<string>
required
  • google_ads - google ads
  • tiktok - tiktok
Available options:
google_ads,
tiktok
​
status
enum<string>
  • active - active
  • expired - expired
  • disabled - disabled
Available options:
active,
expired,
disabled

Response

The deactivated platform account.

​
id
string<uuid>
required
read-only
​
platform_account_id
string
required

External platform account ID

Maximum string length: 255
​
name
string
required
Maximum string length: 255
​
platform
enum<string>
required
  • google_ads - google ads
  • tiktok - tiktok
Available options:
google_ads,
tiktok
​
workspace_id
string<uuid>
required
read-only
​
created_at
string<date-time>
required
read-only
​
updated_at
string<date-time>
required
read-only
​
platform_integration_id
string
required
read-only
​
status
enum<string>
  • active - active
  • expired - expired
  • disabled - disabled
Available options:
active,
expired,
disabled