Jobs

Start a resync and get back where to poll for it

Work that cannot finish inside one request answers 202 Accepted rather than making you wait. Location names the job, and poll in the body is the same URL for clients that read bodies rather than headers.

Starting the same kind twice while it is still running reports the running job instead of queuing a second one, and still answers 202: the work is accepted either way. started says which call was the one that queued it.

Every kind here re-reads accounts you have already connected, so it is safe to repeat. Nothing destructive can be started this way.

post/api/jobs

Request

  • Base URL: https://youspot.com
  • URL: https://youspot.com/api/jobs
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://youspot.com/oauth/authorize, token URL https://youspot.com/oauth/token, scopes: linkedin)

Headers

Idempotency-Keystring

A unique string, usually a UUID, naming this attempt. Repeating a request under the same key returns the first answer instead of writing again, for 24 hours. The same key with a different body is a 422. The answer carries Idempotency-Replayed. A key is scoped to the credential that sent it, so it only ever replays your own answer and never has to be unguessable.

Request body

kind'linkedin_posts_sync' | 'twitter_posts_sync' | 'twitter_connections_sync' | 'embed_objects' required

Which resync to run. Anything else is a 400 that names the ones you can.

Response

The job is queued or already running.

successboolean required
job_idinteger required
kind'linkedin_posts_sync' | 'twitter_posts_sync' | 'twitter_connections_sync' | 'embed_objects' required
state'queued' | 'running' required
startedboolean required

False when this kind was already running and that job is the one named here.

pollstring uri required

Where to poll. The same URL as the Location header.

Changes

No recorded changes to this operation across all 1 revision of this API.