Contact

Request a first conversation with CodeAtlas

An agent submits a first-conversation request on behalf of a person. CodeAtlas emails it to the team and the person is answered at the given email. Only call it after the person asked you to and gave you their name and email. Requires a Bearer token with scope api:write. Honors Idempotency-Key. In the sandbox the request is accepted and never delivered or stored. Limit: 5 per hour per OAuth client.

The response field data.delivery is delivered when the email was sent, stored when it was saved for the team but email delivery was not available, and sandbox in the sandbox.

post/contact-requests

Request

  • Base URL: https://codeatlas.com.br/api/v1
  • URL: https://codeatlas.com.br/api/v1/contact-requests
  • Auth: OAuth 2 (client credentials, token URL https://codeatlas.com.br/oauth2/token, scopes: api:write)

Headers

Idempotency-Keystring

8 to 128 printable ASCII characters, for example a UUID. The same key with the same body replays the first response for 24 hours. The same key with a different body returns 422.

Request body

namestring required

The person's full name.

emailstring email required

The person's email. CodeAtlas replies here.

companystring
messagestring required

What the person wants to discuss.

locale'pt-BR' | 'en'

Reply language.

service_slug'produto-digital' | 'zelvo-ai' | 'consultoria'

Service of interest.

Response

The request was received.

Changes

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