Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /bynder-admin | Type: Application | PCID required: Yes
bynder_admin_create_user
Create a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
active | boolean | No | — | Whether the user account is active |
email | string | Yes | — | Email address for the new user |
firstName | string | No | — | First name |
lastName | string | No | — | Last name |
profileId | string | Yes | — | Security profile ID to assign to the user |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"active": {
"type": "boolean",
"description": "Whether the user account is active"
},
"email": {
"type": "string",
"description": "Email address for the new user"
},
"firstName": {
"type": "string",
"description": "First name"
},
"lastName": {
"type": "string",
"description": "Last name"
},
"profileId": {
"type": "string",
"description": "Security profile ID to assign to the user"
}
},
"required": [
"PCID",
"email",
"profileId"
]
}
bynder_admin_create_workflow_campaign
Create a workflow campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
dateEnd | string | No | — | End date in ISO8601 format |
dateStart | string | No | — | Start date in ISO8601 format |
description | string | No | — | Campaign description |
name | string | Yes | — | Name of the campaign |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dateEnd": {
"type": "string",
"description": "End date in ISO8601 format"
},
"dateStart": {
"type": "string",
"description": "Start date in ISO8601 format"
},
"description": {
"type": "string",
"description": "Campaign description"
},
"name": {
"type": "string",
"description": "Name of the campaign"
}
},
"required": [
"PCID",
"name"
]
}
bynder_admin_create_workflow_group
Create a workflow group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
name | string | Yes | — | Name of the group |
userIds | string[] | No | — | List of user IDs to add to the group |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the group"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of user IDs to add to the group"
}
},
"required": [
"PCID",
"name"
]
}
bynder_admin_create_workflow_job
Create a workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
accountableId | string | No | — | User ID of the accountable person |
campaignId | string | Yes | — | Campaign ID to associate the job with |
description | string | No | — | Job description |
dueDate | string | No | — | Due date in ISO8601 format |
name | string | Yes | — | Name of the job |
presetId | string | No | — | Job preset ID to use as a template |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountableId": {
"type": "string",
"description": "User ID of the accountable person"
},
"campaignId": {
"type": "string",
"description": "Campaign ID to associate the job with"
},
"description": {
"type": "string",
"description": "Job description"
},
"dueDate": {
"type": "string",
"description": "Due date in ISO8601 format"
},
"name": {
"type": "string",
"description": "Name of the job"
},
"presetId": {
"type": "string",
"description": "Job preset ID to use as a template"
}
},
"required": [
"PCID",
"campaignId",
"name"
]
}
bynder_admin_delete_user
Delete a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | User identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "User identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_delete_workflow_campaign
Delete a workflow campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Campaign identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Campaign identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_delete_workflow_group
Delete a workflow group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Group identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Group identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_delete_workflow_job
Delete a workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Job identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_finish_workflow_job
Finish a workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Job identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_get_account_info
Retrieve account information
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bynder_admin_get_current_user
Retrieve current user
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bynder_admin_get_security_profile
Retrieve a specific security profile
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Security profile identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Security profile identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_get_user
Retrieve a specific user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | User identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "User identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_get_workflow_campaign
Retrieve a specific workflow campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Campaign identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Campaign identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_get_workflow_group
Retrieve a specific workflow group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Group identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Group identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_get_workflow_job
Retrieve a specific workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Job identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_get_workflow_job_preset
Retrieve a workflow job preset
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
jobId | string | Yes | — | Job preset identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jobId": {
"type": "string",
"description": "Job preset identifier"
}
},
"required": [
"PCID",
"jobId"
]
}
bynder_admin_get_workflow_user
Retrieve a specific workflow user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | User identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "User identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_list_derivatives
Retrieve derivatives
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bynder_admin_list_groups
Retrieve groups
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bynder_admin_list_security_profiles
Retrieve security profiles
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bynder_admin_list_users
Retrieve users
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
limit | integer | No | — | Maximum results per page |
page | integer | No | — | Page number for pagination |
keyword | string | No | — | Search users by name or email |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum results per page"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
},
"keyword": {
"type": "string",
"description": "Search users by name or email"
}
},
"required": [
"PCID"
]
}
bynder_admin_list_workflow_campaign_jobs
Retrieve jobs of a workflow campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Campaign identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Campaign identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_list_workflow_campaigns
Retrieve workflow campaigns
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
limit | integer | No | — | Maximum results per page |
page | integer | No | — | Page number for pagination |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum results per page"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
bynder_admin_list_workflow_groups
Retrieve workflow groups
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
limit | integer | No | — | Maximum results per page |
page | integer | No | — | Page number for pagination |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum results per page"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
Retrieve media of a workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Job identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_list_workflow_job_stages
Retrieve stages of a workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Job identifier |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job identifier"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_list_workflow_jobs
Retrieve workflow jobs
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
limit | integer | No | — | Maximum results per page |
page | integer | No | — | Page number for pagination |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum results per page"
},
"page": {
"type": "integer",
"description": "Page number for pagination"
}
},
"required": [
"PCID"
]
}
bynder_admin_list_workflow_users
Retrieve workflow users
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
bynder_admin_modify_user
Modify a user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | User identifier |
active | boolean | No | — | Whether the user account is active |
email | string | No | — | Updated email address |
firstName | string | No | — | Updated first name |
lastName | string | No | — | Updated last name |
profileId | string | No | — | Updated security profile ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "User identifier"
},
"active": {
"type": "boolean",
"description": "Whether the user account is active"
},
"email": {
"type": "string",
"description": "Updated email address"
},
"firstName": {
"type": "string",
"description": "Updated first name"
},
"lastName": {
"type": "string",
"description": "Updated last name"
},
"profileId": {
"type": "string",
"description": "Updated security profile ID"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_modify_workflow_campaign
Modify a workflow campaign
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Campaign identifier |
dateEnd | string | No | — | Updated end date |
dateStart | string | No | — | Updated start date |
description | string | No | — | Updated description |
name | string | No | — | Updated campaign name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Campaign identifier"
},
"dateEnd": {
"type": "string",
"description": "Updated end date"
},
"dateStart": {
"type": "string",
"description": "Updated start date"
},
"description": {
"type": "string",
"description": "Updated description"
},
"name": {
"type": "string",
"description": "Updated campaign name"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_modify_workflow_group
Modify a workflow group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Group identifier |
name | string | No | — | Updated group name |
userIds | string[] | No | — | Updated list of user IDs |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Group identifier"
},
"name": {
"type": "string",
"description": "Updated group name"
},
"userIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Updated list of user IDs"
}
},
"required": [
"PCID",
"id"
]
}
bynder_admin_modify_workflow_job
Modify a workflow job
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Job identifier |
accountableId | string | No | — | Updated accountable user ID |
description | string | No | — | Updated description |
dueDate | string | No | — | Updated due date |
name | string | No | — | Updated job name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Job identifier"
},
"accountableId": {
"type": "string",
"description": "Updated accountable user ID"
},
"description": {
"type": "string",
"description": "Updated description"
},
"dueDate": {
"type": "string",
"description": "Updated due date"
},
"name": {
"type": "string",
"description": "Updated job name"
}
},
"required": [
"PCID",
"id"
]
}