Oblic

ਉਪ-ਖਾਤੇ

ਆਪਣੇ ਗਾਹਕਾਂ ਵੱਲੋਂ ਸੁਨੇਹੇ ਭੇਜਣ ਵਾਲਾ ਪਲੇਟਫਾਰਮ ਹਰ ਗਾਹਕ ਨੂੰ ਉਪ-ਖਾਤਾ ਦਿੰਦਾ ਹੈ: ਆਪਣੇ ਭੇਜਣ ਵਾਲਿਆਂ, ਟੈਂਪਲੇਟਾਂ, ਸੁਨੇਹਿਆਂ ਅਤੇ ਰਿਪੋਰਟਾਂ ਵਾਲੀ ਵੱਖਰੀ Oblic ਸੰਸਥਾ। ਉਸ ਨੂੰ ਦਰਸਾ ਕੇ ਤੁਹਾਡੀ ਕੁੰਜੀ ਉਸ ਵੱਲੋਂ ਕੰਮ ਕਰਦੀ ਹੈ। ਉਪ-ਖਾਤਿਆਂ ਦੇ ਪ੍ਰਬੰਧ ਲਈ accounts:manage ਵਾਲੀ Owner ਜਾਂ Admin ਕੁੰਜੀ ਲੋੜੀਂਦੀ ਹੈ।


POST/external/v1/accounts

ਉਪ-ਖਾਤਾ ਬਣਾਉਣਾ

  • ਨਾਮ
    name
    ਟਾਈਪ ਕਰੋ
    string
    ਵਰਣਨ

    ਲਾਜ਼ਮੀ: ਗਾਹਕ ਦਾ ਨਾਮ, ਵੱਧ ਤੋਂ ਵੱਧ 511 ਅੱਖਰ।

  • ਨਾਮ
    externalId
    ਟਾਈਪ ਕਰੋ
    string
    ਵਰਣਨ

    ਲਾਜ਼ਮੀ: ਤੁਹਾਡੇ ਸਿਸਟਮ ਵਿੱਚ ਗਾਹਕ ਦੀ ਪਛਾਣ, ਵੱਧ ਤੋਂ ਵੱਧ 100 ASCII ਅੱਖਰ, ਅੰਕ ਅਤੇ _, ., :, - ਚਿੰਨ੍ਹ। ਅੱਗੇ ਇਸ ਨਾਲ ਉਪ-ਖਾਤਾ ਦਰਸਾਇਆ ਜਾਂਦਾ ਹੈ।

  • ਨਾਮ
    issueKey
    ਟਾਈਪ ਕਰੋ
    boolean
    ਵਰਣਨ

    ਉਪ-ਖਾਤੇ ਨੂੰ ਆਪਣੀ API ਕੁੰਜੀ ਦੇਣੀ ਹੈ ਜਾਂ ਨਹੀਂ; ਮੂਲ ਮੁੱਲ true ਹੈ।

ਉਪ-ਖਾਤਾ ਬਣਾਉਣਾ

curl -X POST https://api.oblic.app/external/v1/accounts \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Asha Textiles", "externalId": "tenant-4821" }'

ਜਵਾਬ

{
  "status": "success",
  "data": {
    "id": "ORG000R7ZM4Q2VXH00",
    "name": "Asha Textiles",
    "externalId": "tenant-4821",
    "active": true,
    "createdAt": "2026-10-24T09:30:00Z",
    "apiKey": "obl_live_…"
  },
  "errors": null
}
  • apiKey ਸਿਰਫ਼ ਇਸ ਜਵਾਬ ਵਿੱਚ ਦਿਖਦੀ ਹੈ: ਉਸੇ ਵੇਲੇ ਸੰਭਾਲੋ ਜਾਂ ਹੋਰ ਕੁੰਜੀ ਲਈ ਉਪ-ਖਾਤਾ ਦੁਬਾਰਾ ਬਣਾਓ। ਇਹ ਪੁਰਾਣੀਆਂ ਮੂਲ ਇਜਾਜ਼ਤਾਂ ਵਾਲੀ User ਕੁੰਜੀ ਹੈ, ਜਿਨ੍ਹਾਂ ਵਿੱਚ events:write ਨਹੀਂ ਹੈ: ਭੇਜਣਾ, ਪੜ੍ਹਨਾ ਅਤੇ ਪਛਾਣਾਂ ਤੇ ਸੰਪਰਕ ਸੂਚੀਆਂ ਦਾ ਪ੍ਰਬੰਧ ਹੋ ਸਕਦਾ ਹੈ, ਪਰ Owner ਜਾਂ Admin ਕੁੰਜੀ ਮੰਗਣ ਵਾਲੇ ਰੂਟ ਨਹੀਂ ਵਰਤੇ ਜਾ ਸਕਦੇ।
  • ਉਹੀ externalId ਦੁਬਾਰਾ ਭੇਜਣ ਨਾਲ ਉਹੀ ਉਪ-ਖਾਤਾ ਮਿਲਦਾ ਹੈ; ਬੰਦ ਹੋਵੇ ਤਾਂ ਮੁੜ ਸਰਗਰਮ ਹੁੰਦਾ ਹੈ ਅਤੇ ਨਾਮ ਨਹੀਂ ਬਦਲਦਾ। ਜੇ issueKey ਦਾ ਮੁੱਲ false ਨਹੀਂ ਹੈ ਤਾਂ ਹਰ ਕਾਲ ਹੋਰ ਕੁੰਜੀ ਜਾਰੀ ਕਰਦੀ ਹੈ। ਬੰਦ ਕਰਨ ਸਮੇਂ ਰੱਦ ਕੀਤੀਆਂ ਕੁੰਜੀਆਂ ਤੋਂ ਇਲਾਵਾ ਪੁਰਾਣੀਆਂ ਵੀ ਕੰਮ ਕਰਦੀਆਂ ਰਹਿੰਦੀਆਂ ਹਨ।
  • ਉਪ-ਖਾਤੇ ਦੇ ਆਪਣੇ ਉਪ-ਖਾਤੇ ਨਹੀਂ ਹੁੰਦੇ: ਉਪ-ਖਾਤੇ ਵੱਲੋਂ ਕੰਮ ਕਰਦਿਆਂ ਹੋਰ ਬਣਾਉਣ ਨਾਲ 403 SUB_ACCOUNT_NOT_ALLOWED ਮਿਲਦਾ ਹੈ।

GET/external/v1/accounts

ਉਪ-ਖਾਤਿਆਂ ਦੀ ਸੂਚੀ ਵੇਖਣਾ

ਬਣਾਉਣ ਦੇ ਕ੍ਰਮ ਵਿੱਚ ਸਾਰੇ ਉਪ-ਖਾਤੇ ਮਿਲਦੇ ਹਨ, ਜਿਨ੍ਹਾਂ ਵਿੱਚ active ਦਾ ਮੁੱਲ false ਵਾਲੇ ਬੰਦ ਖਾਤੇ ਵੀ ਹਨ। ਸੂਚੀ ਵਿੱਚ ਕਦੇ ਕੁੰਜੀਆਂ ਨਹੀਂ ਹੁੰਦੀਆਂ।


DELETE/external/v1/accounts/{accountId}

ਉਪ-ਖਾਤਾ ਬੰਦ ਕਰਨਾ

Oblic ਦੇ id ਨਾਲ ਉਪ-ਖਾਤਾ ਬੰਦ ਕਰਦਾ ਹੈ, ਤੁਹਾਡੇ externalId ਨਾਲ ਨਹੀਂ, ਅਤੇ ਉਸ ਦੀਆਂ ਸਾਰੀਆਂ ਕੁੰਜੀਆਂ ਤੁਰੰਤ ਰੱਦ ਕਰਦਾ ਹੈ। ਉਸੇ externalId ਨਾਲ ਦੁਬਾਰਾ ਬਣਾਉਣ ਉੱਤੇ ਸਰਗਰਮ ਹੋ ਜਾਂਦਾ ਹੈ। ਸੰਸਥਾ ਨਾਲ ਸੰਬੰਧਿਤ ਨਾ ਹੋਣ ਵਾਲੇ ਉਪ-ਖਾਤੇ ਲਈ 404 ACCOUNT_NOT_FOUND ਮਿਲਦਾ ਹੈ।


ਉਪ-ਖਾਤੇ ਵੱਲੋਂ ਕੰਮ ਕਰਨਾ

X-Oblic-On-Behalf-Of ਵਿੱਚ ਉਪ-ਖਾਤੇ ਦਾ externalId ਭੇਜੋ। ਬੇਨਤੀ ਉਸ ਦੀ ਆਪਣੀ ਕੁੰਜੀ ਵਰਤਣ ਵਾਂਗ ਉਸ ਵੱਲੋਂ ਚੱਲਦੀ ਹੈ। ਇੱਕ ਕੁੰਜੀ ਸਾਰੇ ਗਾਹਕਾਂ ਲਈ ਕੰਮ ਕਰਦੀ ਹੈ; ਹਰ ਗਾਹਕ ਲਈ ਵੱਖਰੀ ਕੁੰਜੀ ਰੱਖਣ ਦੀ ਲੋੜ ਨਹੀਂ।

ਗਾਹਕ ਦੇ ਖਾਤੇ ਤੋਂ ਭੇਜਣਾ

curl -X POST https://api.oblic.app/external/v1/messages/email \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'X-Oblic-On-Behalf-Of: tenant-4821' \
  -H 'Content-Type: application/json' \
  -d '{ "from": "hello@ashatextiles.example", "to": ["asha@example.org"], "subject": "Welcome", "html": "<p>Welcome!</p>" }'
  • ਉਪ-ਖਾਤੇ ਦਾ ਆਪਣਾ: ਈਮੇਲ ਸਿਰਫ਼ ਉਸ ਦੀਆਂ ਆਪਣੀਆਂ ਪਛਾਣਾਂ ਤੋਂ ਜਾਂਦੀ ਹੈ; ਸੁਨੇਹੇ, ਰਿਪੋਰਟਾਂ, ਟੈਂਪਲੇਟ, ਵੈਬਹੁੱਕ ਅਤੇ Idempotency-Key ਮੁੱਲ ਵੀ ਉਸ ਦੇ ਆਪਣੇ ਹਨ।
  • ਤੁਹਾਡੀ ਸੰਸਥਾ ਦਾ: ਤੁਹਾਡੀ ਸੰਸਥਾ ਦਾ ਵਾਲਿਟ ਉਸ ਦੇ ਸੁਨੇਹਿਆਂ ਦਾ ਭੁਗਤਾਨ ਕਰਦਾ ਹੈ ਅਤੇ ਉਸ ਵੱਲੋਂ ਕੀਤੀਆਂ ਬੇਨਤੀਆਂ ਉੱਤੇ ਤੁਹਾਡੀ ਮਨਜ਼ੂਰ IP ਸੂਚੀ ਲਾਗੂ ਹੁੰਦੀ ਹੈ।
  • ਤੁਹਾਡੀ ਕੁੰਜੀ ਦੀ ਭੂਮਿਕਾ ਲਾਗੂ ਰਹਿੰਦੀ ਹੈ, ਇਸ ਲਈ ਗਾਹਕ ਦੇ ਟੈਂਪਲੇਟ, ਵੈਬਹੁੱਕ ਜਾਂ WhatsApp ਨੰਬਰ ਨੂੰ ਆਪਣੀ Owner ਜਾਂ Admin ਕੁੰਜੀ ਅਤੇ ਹੈਡਰ ਨਾਲ ਸੰਭਾਲੋ।
  • ਸਰਗਰਮ ਉਪ-ਖਾਤੇ ਨਾਲ ਨਾ ਮਿਲਣ ਵਾਲੇ externalId ਲਈ 404 ACCOUNT_NOT_FOUND ਮਿਲਦਾ ਹੈ।
  • ਉਪ-ਖਾਤੇ ਦੀਆਂ ਵੈਬਹੁੱਕ ਘਟਨਾਵਾਂ ਉਸ ਦੇ ਆਪਣੇ ਐਂਡਪੁਆਇੰਟ ਹੋਣ ਤਾਂ ਉੱਥੇ, ਨਹੀਂ ਤਾਂ ਤੁਹਾਡੇ ਐਂਡਪੁਆਇੰਟ ਉੱਤੇ ਜਾਂਦੀਆਂ ਹਨ। ਉਸ ਦਾ externalId ਹਰ ਘਟਨਾ ਦੇ account ਵਿੱਚ ਹੁੰਦਾ ਹੈ। ਵੈਬਹੁੱਕ ਵੇਖੋ।
  • ਉਪ-ਖਾਤੇ ਤੋਂ ਭੇਜੇ SMS ਟੈਂਪਲੇਟ ਉਹ ਹਨ ਜੋ ਤੁਸੀਂ ਉਸ ਨਾਲ ਸਾਂਝੇ ਕਰਦੇ ਹੋ। ਟੈਂਪਲੇਟ ਵੇਖੋ।
ਕੀ ਇਹ ਪੰਨਾ ਮਦਦਗਾਰ ਸੀ?