Register an Asset to an advertiser

Places an Asset in one advertiser’s provider-side library. Not a provider — an organization has several ad accounts, and the bytes land in exactly one of them.

Returns immediately with a running Registration; poll GET /assets/{id} for its state. Video can take several minutes to process at the provider, which is normal rather than a failure.

Registering the same Asset to the same advertiser twice is refused rather than duplicated.

POST/assets/{id}/registrations

Authorization

AuthorizationBearer token · headerrequired

Send Authorization: Bearer <credential>. Two credentials work.

An API key (acr_…) is what a server integration uses. Create one in the AdCrunch console under Settings → API keys — see https://docs.adcrunch.dev/account/api-keys. A key is bound to the organization that was active when you created it, and it keeps acting on that organization whatever you do later. It carries the permissions of the member who created it.

A session issued by the AdCrunch sign-in flow also works, which is how the console calls this service from the browser.

Either way the organization comes from the credential. There is no organization parameter.

Path parameters

idstringrequired

matches ^(ast_)[\s\S]{0,}$

Request body

requiredapplication/json

advertiserIdstringrequired

The advertiser whose library the bytes land in. Its provider decides how they get there.

matches ^(acc_)[\s\S]{0,}$

Responses

200

The Registration, at running. providerIdentifier is null until the provider has the bytes — read the Asset to see it settle.

advertiserIdstringrequired

The advertiser whose library holds the bytes.

assetIdstringrequired

createdAtnumberrequired

Milliseconds since the Unix epoch, UTC.

deletedAtnumber | nullrequired

Set when a failed attempt was tombstoned to free the pair for a retry. null on a live Registration.

failureReasonstring | nullrequired

The provider’s own code and message. Only set on a failure.

idstringrequired

organizationIdstringrequired

providerstringrequired

The provider that owns the advertiser.

Allowed:metagadstiktokxopenaisnapchatdv360

providerIdentifierstring | nullrequired

What the provider gave back — a Meta image hash or video id. null until the Registration is ready. This is the id a creative is built with.

statusstringrequired

Video can stay running for several minutes while the provider processes it. That is normal, and not a failure.

Allowed:runningreadyfailed

updatedAtnumber | nullrequired

Milliseconds since the Unix epoch, UTC.

uploadSessionIdstring | nullrequired

An in-flight provider upload session, where the protocol has one. null for every image.

workflowIdstringrequired

The durable execution that placed it.

401

No credential, or one that does not resolve. Send an API key or a session. See the security scheme. error is unauthorized.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:unauthorized

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

403

The caller does not hold asset:write. error is forbidden.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

Allowed:forbidden

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

404

No stored Asset with that id, or no such advertiser in this organization. The two are one answer, so the surface cannot be used to discover that an id is real. error is not_found.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

409

This Asset is already in that advertiser’s library. error is already_registered.

errorstringrequired

A stable code for the failure. This is the field to branch on. It does not change for a given failure.

messagestringrequired

A sentence to show a person. Written to say what to do next. Reworded whenever it can be said better, so never branch on it.

422

The request did not match this operation’s schema. This is the framework’s own shape, not the error/message one.

errorsobject[]required

One entry per failing field.

foundanyrequired

What was sent.

messagestringrequired

onstringrequired

Which part of the request failed: body, query or params.

propertystringrequired

The field that failed.

typestringrequired

Allowed:validation

Request

curl -X POST "https://api.adcrunch.dev/assets/string/registrations" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "advertiserId": "string"
}'

const response = await fetch("https://api.adcrunch.dev/assets/string/registrations", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"advertiserId\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://api.adcrunch.dev/assets/string/registrations",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"advertiserId\": \"string\"\n}",
)

Response

{
  "advertiserId": "string",
  "assetId": "string",
  "createdAt": 0,
  "deletedAt": 0,
  "failureReason": "string",
  "id": "string",
  "organizationId": "string",
  "provider": "meta",
  "providerIdentifier": "string",
  "status": "running",
  "updatedAt": 0,
  "uploadSessionId": "string",
  "workflowId": "string"
}

{
  "error": "unauthorized",
  "message": "string"
}

{
  "error": "forbidden",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "error": "string",
  "message": "string"
}

{
  "errors": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "found": null,
  "message": "string",
  "on": "string",
  "property": "string",
  "type": "validation"
}