GET & PUT /v1/projects/me — Project Settings

The /v1/projects/me endpoint gives you access to your project’s configuration. Use the GET operation to inspect current settings, and the PUT operation to connect your Meta credentials and webhook URL before sending your first message.

Retrieve project details

GET https://api.relayos.com.br/v1/projects/me Returns the current configuration for your project, including your Meta credentials status and registered callback URL.

curl https://api.relayos.com.br/v1/projects/me \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

string

Unique identifier for your project.

string

Project display name.

string

Contact email for the project owner.

string

Your Meta Phone Number ID, if configured.

string

Webhook URL where RelayOS sends message status events, if configured.

string

ISO 8601 timestamp of project creation.

{
  "projectId": "proj_01hwxyz111aaa",
  "name": "My Production App",
  "ownerEmail": "you@yourcompany.com",
  "metaPhoneNumberId": "1234567890",
  "callbackUrl": "https://yoursite.com/webhook/relayos",
  "createdAt": "2026-05-14T10:00:00Z"
}

Update Meta credentials

PUT https://api.relayos.com.br/v1/projects/me/meta-credentials Configure or update the Meta credentials and webhook URL that RelayOS uses to send WhatsApp messages on your behalf. You must call this endpoint before you can send any messages.

string

required

Your WhatsApp Phone Number ID from the Meta Developer Console. Found under WhatsApp > API Setup in your Meta app.

string

required

A valid Meta access token with whatsapp_business_messaging permissions. For production, use a permanent system user token.

string

HTTPS URL where RelayOS will send webhook events for message status updates (e.g., DELIVERED, READ, FAILED). Optional — you can add or update it at any time.

curl -X PUT https://api.relayos.com.br/v1/projects/me/meta-credentials \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "metaPhoneNumberId": "1234567890",
    "metaAccessToken": "EAAxxxYYYzzz...",
    "callbackUrl": "https://yoursite.com/webhook/relayos"
  }'

Response

A 200 response confirms the credentials were saved.

string

Your project identifier.

string

The Phone Number ID that was saved.

string

The webhook URL that was saved.

string

ISO 8601 timestamp of the update.

{
  "projectId": "proj_01hwxyz111aaa",
  "metaPhoneNumberId": "1234567890",
  "callbackUrl": "https://yoursite.com/webhook/relayos",
  "updatedAt": "2026-05-14T12:30:00Z"
}

The metaAccessToken is never returned in responses. To rotate your token, call this endpoint again with the new value.

Messages

Templates

Projects & Keys

GET & PUT /v1/projects/me — Project Settings

Retrieve project details

Response

Update Meta credentials

Response

​Retrieve project details

​Response

​Update Meta credentials

​Response

Retrieve project details

Response

Update Meta credentials

Response