Social Accounts

Add a social account

This API gives you access to adding a social account to your workspace.

Steps of filling credentials object:

1. Make an API call to this.

2. You'll get a list of all authVariables, every object in that array will contain keyname

3. You'll use the value of name key, as a key in credentials object, then credentials object will look like this

"credentials": {
    "csrf-token": "<value>"
}

Steps of filling platform object:

1. Use platformId for the value of id, use this for getting platformId

2. userId will be the unique identifier of the user for that platform

3. picture will be the profile picture URL

post

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

namestringrequired

platformobjectoptional

latitudestringoptional

longitudestringoptional

variablesobjectrequired

credentialsobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v1/public/social-accounts' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "platform": {
      "id": "text",
      "userId": "text",
      "picture": "text",
      "location": "text",
      "metadata": {}
    },
    "latitude": "text",
    "longitude": "text",
    "variables": {},
    "credentials": {}
  }'

201

401

403

422

500

201

{
  "success": true,
  "message": "Account connected successfully",
  "data": {
    "id": "The social account ID",
    "name": "The social account name",
    "readyToUse": true
  }
}

Account connected successfully

Get All social accounts

This API will return all social accounts of a workspace

get

Authorizations

Query parameters

startnumberrequired

The page No

Example: 0

limitnumber · min: 1 · max: 50required

The Page Size

Example: 10

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/social-accounts?start=1&limit=1' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

204

401

422

500

200

{
  "success": true,
  "message": "All social accounts fetched successfully",
  "data": [
    {
      "id": "Social Account ID",
      "socialAccountName": "Alex Jordan",
      "platformName": "Linkedin",
      "proxyId": "6745retfderty6",
      "credentialsIsExpired": false,
      "proxyIsExpired": false
    }
  ]
}

Account listed successfully

Get social account by ID

This API will give you social account details by its ID

get

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/social-accounts/{accountId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "text",
  "data": {
    "id": "text",
    "socialAccountName": "text",
    "platformName": "text",
    "platformId": "text",
    "credentials": {},
    "proxyId": "text",
    "variables": {
      "key": "text"
    },
    "limits": {
      "platformOperationsId": [
        "text"
      ]
    },
    "credentialsIsExpired": true,
    "proxyIsExpired": true,
    "platformUserId": "text",
    "readyToUse": true
  }
}

Account fetched successfully

Update a social account

This API will be used for updating the credential or proxy

put

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

credentialsobjectoptional

variablesobjectoptional

namestringoptional

proxyIdstringoptional

latitudestringoptional

longitudestringoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/public/social-accounts/{accountId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "credentials": {},
    "variables": {},
    "name": "text",
    "proxyId": "text",
    "latitude": "text",
    "longitude": "text"
  }'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "Account updated successfully",
  "data": {
    "id": "The social account ID",
    "name": "The social account name",
    "readyToUse": true
  }
}

Account updated successfully

Assign proxy to a social account

Use this API to assign a proxy to a social account and get proxyId from this API.

Always use a proxy with a social account.

put

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

proxyIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/public/social-accounts/{accountId}/proxy' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "proxyId": "text"
  }'

200

401

403

404

422

500

200

{
  "success": true,
  "message": "Proxy assigned successfully",
  "data": {
    "socialAccountId": "The social account ID",
    "proxyId": "The proxy ID"
  }
}

Proxy assigned successfully

Remove proxy from a social account

Use this API to remove the proxy from the social account.

Not using a proxy may lead to suspending your social account.

delete

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/public/social-accounts/{accountId}/proxy' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

422

500

200

{
  "success": true,
  "message": "Proxy removed successfully from this account"
}

Proxy removed successfully from this account

Reset proxy of a social account.

This API will reset only the factory proxy not the user proxy of a social account.

get

Authorizations

Path parameters

accountIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/public/social-accounts/{accountId}/reset-proxy' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

204

401

404

422

200

No body

Proxy Location Reset Successfully

Set limit

Use this API to set automation limits for the specific social account

put

Authorizations

Path parameters

accountIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

operationIdstringrequired

executionLimitobject[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v1/public/social-accounts/{accountId}/limit' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "operationId": "text",
    "executionLimit": [
      {
        "limit": "text",
        "interval": {}
      }
    ]
  }'

200

204

401

404

422

500

200

{
  "success": true,
  "message": "message",
  "data": {
    "socialAccountId": "The social account ID"
  }
}

Account limit updated successfully

Reset Limit to default (Delete limit)

Use this API to reset the limit of automation to default one (delete the limit at the account level)

delete

Authorizations

Path parameters

accountIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Body

operationIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/public/social-accounts/{accountId}/limit' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "operationId": "text"
  }'

200

204

401

404

422

500

200

{
  "success": true,
  "message": "message",
  "data": {
    "socialAccountId": "The social account ID"
  }
}

Account limit deleted successfully

Delete a social account

delete

Authorizations

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/public/social-accounts/{accountId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

401

403

404

412

422

500

200

{
  "success": true,
  "message": "Account deleted successfully",
  "data": {
    "id": "The social account ID",
    "name": "The social account name",
    "readyToUse": true
  }
}

Account deleted successfully

Force Delete a social account

This endpoint is being used when a social account is used in running workflow, and user wish to force delete it.

delete

Authorizations

Path parameters

accountIdstringrequired

Header parameters

X-TexAu-Contextstringrequired

Pass orgUserId and workspaceId as ‘{"orgUserId":"123","workspaceId":"123"}’

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v1/public/social-accounts/{accountId}/force' \
  --header 'Authorization: Bearer JWT' \
  --header 'X-TexAu-Context: text'

200

204

401

404

422

500

200

{
  "success": true,
  "message": "Account deleted successfully",
  "data": {
    "id": "The social account ID",
    "name": "The social account name"
  }
}

Account deleted successfully