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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

namestringRequired

latitudestringOptional

longitudestringOptional

variablesobjectRequired

credentialsobjectRequired

Responses

201

Account connected successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

422

Requested workspace does not belongs to you

500

Error in adding social account

post

/api/v1/public/social-accounts

HTTPcURLJavaScriptPython

POST /api/v1/public/social-accounts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "name": "text",
  "platform": {
    "id": "text",
    "userId": "text",
    "picture": "text",
    "location": "text",
    "metadata": {}
  },
  "latitude": "text",
  "longitude": "text",
  "variables": {},
  "credentials": {}
}

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

Get All social accounts

This API will return all social accounts of a workspace

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startnumberOptional

limitnumber · min: 1 · max: 50Optional

platformIdstringOptional

The platform ID, must be a valid MongoDB ID

onlyReadystringOptional

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Account listed successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

422

Requested workspace does not belongs to you

500

Error in listing social accounts

get

/api/v1/public/social-accounts

HTTPcURLJavaScriptPython

GET /api/v1/public/social-accounts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

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

Get social account by ID

This API will give you social account details by its ID

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Account fetched successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Account not found

422

Requested workspace does not belongs to you

500

Error in fetching social account

get

/api/v1/public/social-accounts/{accountId}

HTTPcURLJavaScriptPython

GET /api/v1/public/social-accounts/{accountId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "Account fetched successfully",
  "data": {
    "id": "Social Account ID",
    "socialAccountName": "Alex Jordan",
    "platformName": "Linkedin",
    "platformId": "6745retfderty6",
    "credentials": {},
    "proxyId": "6745retfderty6",
    "variables": {
      "key": "value"
    },
    "limits": {
      "platformOperationsId": [
        {
          "limit": "100",
          "interval": "daily | hourly"
        }
      ]
    },
    "credentialsIsExpired": false,
    "proxyIsExpired": false,
    "platformUserId": "https://www.linkedin.com/in/prathmesh-kumar-saini/",
    "readyToUse": false
  }
}

Update a social account

This API will be used for updating the credential or proxy

put

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

credentialsobjectOptional

variablesobjectOptional

namestringOptional

proxyIdstringOptional

latitudestringOptional

longitudestringOptional

Responses

200

Account updated successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Account does not exist

422

Requested workspace does not belongs to you

500

Error in updating social account

put

/api/v1/public/social-accounts/{accountId}

HTTPcURLJavaScriptPython

PUT /api/v1/public/social-accounts/{accountId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "credentials": {},
  "variables": {},
  "name": "text",
  "proxyId": "text",
  "latitude": "text",
  "longitude": "text"
}

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

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

proxyIdstringRequired

Responses

200

Proxy assigned successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Connected account not found.

422

Requested workspace does not belongs to you

500

Error occurred in assigning proxy to connected account.

put

/api/v1/public/social-accounts/{accountId}/proxy

HTTPcURLJavaScriptPython

PUT /api/v1/public/social-accounts/{accountId}/proxy HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "proxyId": "text"
}

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

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Proxy removed successfully from this account

application/json

401

Unauthorized access

403

Your plan does not have API access

422

Requested workspace does not belongs to you

500

Error in removing proxy from this account

delete

/api/v1/public/social-accounts/{accountId}/proxy

HTTPcURLJavaScriptPython

DELETE /api/v1/public/social-accounts/{accountId}/proxy HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

{
  "success": true,
  "message": "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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Proxy Location Reset Successfully

No content

401

Unauthorized access

403

Your plan does not have API access

404

Account not found

422

Proxy you are trying to reset is not factory proxy

get

/api/v1/public/social-accounts/{accountId}/reset-proxy

HTTPcURLJavaScriptPython

GET /api/v1/public/social-accounts/{accountId}/reset-proxy HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

No content

Set limit

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

put

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

operationIdstringRequired

Responses

200

Account limit updated successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Account does not exist

422

Requested workspace does not belongs to you

500

Error in updating social account limit

put

/api/v1/public/social-accounts/{accountId}/limit

HTTPcURLJavaScriptPython

PUT /api/v1/public/social-accounts/{accountId}/limit HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "operationId": "text",
  "executionLimit": [
    {
      "limit": "1000",
      "interval": "hourly"
    }
  ]
}

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

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Body

application/json

operationIdstringRequired

Responses

200

Account limit deleted successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Account does not exist

422

Requested workspace does not belongs to you

500

Error in deleting social account limit

delete

/api/v1/public/social-accounts/{accountId}/limit

HTTPcURLJavaScriptPython

DELETE /api/v1/public/social-accounts/{accountId}/limit HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "operationId": "text"
}

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

Delete a social account

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Account deleted successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Account not found

412

Account cannot be deleted as it is running in an automation. Please stop and delete automation and retry

422

Requested workspace does not belongs to you

500

Error in deleting social account

delete

/api/v1/public/social-accounts/{accountId}

HTTPcURLJavaScriptPython

DELETE /api/v1/public/social-accounts/{accountId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

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

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

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

accountIdstringRequired

Header parameters

X-TexAu-ContextstringRequired

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

Responses

200

Account deleted successfully

application/json

401

Unauthorized access

403

Your plan does not have API access

404

Account not found

422

Requested workspace does not belongs to you

500

Error in deleting social account

delete

/api/v1/public/social-accounts/{accountId}/force

HTTPcURLJavaScriptPython

DELETE /api/v1/public/social-accounts/{accountId}/force HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
X-TexAu-Context: text
Accept: */*

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